Engine Class

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

Access this object via the Cantabile#engine property.

class Engine {
    isStarted(): Promise<boolean>;
    start(): Promise<void>;
    stop(): Promise<void>;
    restart(): Promise<void>;
    startStop(): Promise<void>;
}

#Methods

#isStarted()

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

This API is only available via AJAX, and not WebSocket

isStarted(): Promise<boolean>;

#restart()

Restarts Cantabile's audio engine

This API is only available via AJAX, and not WebSocket

restart(): Promise<void>;

#start()

Starts Cantabile's audio engine

This API is only available via AJAX, and not WebSocket

start(): Promise<void>;

#startStop()

Toggles the audio engine between started and stopped

This API is only available via AJAX, and not WebSocket

startStop(): Promise<void>;

#stop()

Stops Cantabile's audio engine

This API is only available via AJAX, and not WebSocket

stop(): Promise<void>;