Transport Class

Interface to the master transport

Access this object via the Cantabile#transport property.

class Transport extends EndPoint {
    set state(value: TransportState);
    get state(): TransportState;
    get timeSignatureNum(): number;
    get timeSignatureDen(): number;
    get timeSignature(): string;
    get tempo(): number;
    set loopMode(value: TransportLoopMode);
    get loopMode(): TransportLoopMode;
    get loopCount(): number;
    get loopIteration(): number;
    play(): void;
    togglePlayPause(): void;
    togglePause(): void;
    togglePlay(): void;
    togglePlayStop(): void;
    pause(): void;
    stop(): void;
    cycleLoopMode(): void;
}

#Properties

#loopCount

Gets the current loopCount

get loopCount(): number;

#loopIteration

Gets the current loopIteration

get loopIteration(): number;

#loopMode

Gets or sets the current loopMode

get loopMode(): TransportLoopMode;

set loopMode(value: TransportLoopMode);

#state

The current transport state.

get state(): TransportState;

set state(value: TransportState);

#tempo

Gets the current tempo

get tempo(): number;

#timeSignature

Gets the current time signature as a string (eg: "3/4")

get timeSignature(): string;

#timeSignatureDen

Gets the current time signature denominator

get timeSignatureDen(): number;

#timeSignatureNum

Gets the current time signature numerator

get timeSignatureNum(): number;

#Methods

#cycleLoopMode()

Cycles between the various loop modes

cycleLoopMode(): void;

#pause()

Pauses the master transport

pause(): void;

#play()

Starts transport playback

play(): void;

#stop()

Stops the master transport

stop(): void;

#togglePause()

Toggles pause and play states (unless stopped)

togglePause(): void;

#togglePlay()

Toggles play and stopped states

togglePlay(): void;

#togglePlayPause()

Toggles between play and pause states

togglePlayPause(): void;

#togglePlayStop()

Toggles between play and stop states

togglePlayStop(): void;

#Events

#'loopStateChanged' Event

Fired when the current loop mode, loop iteration or loop count has changed

transport.on('loopStateChanged', () => { });

#'stateChanged' Event

Fired when the current transport state has changed

transport.on('stateChanged', () => { });

#'tempoChanged' Event

Fired when the current tempo has changed

transport.on('tempoChanged', () => { });

#'timeSignatureChanged' Event

Fired when the current time signature has changed

transport.on('timeSignatureChanged', () => { });