Cantabile JavaScript API Cantabile JavaScript API

  • API Docs for Version: 4.0.0

    • Show:

    Engine

    Provides access to Cantabile's engine object for start/stop control

    Access this object via the engine property.

    Table of Contents

    Methods

    isStarted () Promise | Boolean

    Defined in Engine.js:18

    Returns a promise to provide the started state of Cantabile's audio engine.

    This API is only available via AJAX, and not WebSocket

    Returns:

    Promise | Boolean
    restart () Promise

    Defined in Engine.js:58

    Restarts Cantabile's audio engine

    This API is only available via AJAX, and not WebSocket

    Returns:

    Promise
    start () Promise

    Defined in Engine.js:32

    Starts Cantabile's audio engine

    This API is only available via AJAX, and not WebSocket

    Returns:

    Promise
    startStop () Promise

    Defined in Engine.js:71

    Toggles the audio engine between started and stopped

    This API is only available via AJAX, and not WebSocket

    Returns:

    Promise
    stop () Promise

    Defined in Engine.js:45

    Stops Cantabile's audio engine

    This API is only available via AJAX, and not WebSocket

    Returns:

    Promise