alphaTab.synth.IBackingTrackSynthOutput

A synth output for playing backing tracks.

 interface IBackingTrackSynthOutput extends ISynthOutput

Properties

backingTrackDuration

The total duration of the backing track in milliseconds.

JavaScript

readonly backingTrackDuration: number;

C#

double BackingTrackDuration { get; }

Kotlin

val backingTrackDuration: Double

masterVolume

The volume at which the output should play (0-1)

JavaScript

masterVolume: number;

C#

double MasterVolume { get; set; }

Kotlin

var masterVolume: Double

playbackRate

The playback rate at which the output should playback.

JavaScript

playbackRate: number;

C#

double PlaybackRate { get; set; }

Kotlin

var playbackRate: Double

ready

Fired when the output has been successfully opened and is ready to play samples. (Inherited from ISynthOutput )

JavaScript

readonly ready: IEventEmitter;

C#

IEventEmitter Ready { get; }

Kotlin

val ready: IEventEmitter

sampleRate

Gets the sample rate required by the output. (Inherited from ISynthOutput )

JavaScript

readonly sampleRate: number;

C#

double SampleRate { get; }

Kotlin

val sampleRate: Double

sampleRequest

Fired when the output needs more samples to be played. (Inherited from ISynthOutput )

JavaScript

readonly sampleRequest: IEventEmitter;

C#

IEventEmitter SampleRequest { get; }

Kotlin

val sampleRequest: IEventEmitter

samplesPlayed

Fired when a certain number of samples have been played. (Inherited from ISynthOutput )

JavaScript

readonly samplesPlayed: IEventEmitterOfT<number>;

C#

IEventEmitterOfT<double> SamplesPlayed { get; }

Kotlin

val samplesPlayed: IEventEmitterOfT<Double>

timeUpdate

An event fired when the playback time changes. The time is in absolute milliseconds.

JavaScript

readonly timeUpdate: IEventEmitterOfT<number>;

C#

IEventEmitterOfT<double> TimeUpdate { get; }

Kotlin

val timeUpdate: IEventEmitterOfT<Double>

Methods

activate

Activates the output component. (Inherited from ISynthOutput )

JavaScript

activate(): void

C#

void Activate()

Kotlin

fun activate(): Unit

addSamples

Called when samples have been synthesized and should be added to the playback buffer. (Inherited from ISynthOutput )

JavaScript

addSamples(samples: Float32Array): void

C#

void AddSamples(Float32Array samples)

Kotlin

fun addSamples(samples: Float32Array): Unit

Parameter	Summary
samplesAll	(no description)

destroy

Requests the output to destroy itself. (Inherited from ISynthOutput )

JavaScript

destroy(): void

C#

void Destroy()

Kotlin

fun destroy(): Unit

enumerateOutputDevices

Loads and lists the available output devices. Will request permissions if needed. (Inherited from ISynthOutput )

JavaScript

enumerateOutputDevices(): Promise<ISynthOutputDevice[]>

C#

System.Threading.Task<IList<ISynthOutputDevice>> EnumerateOutputDevices()

Kotlin

suspend fun enumerateOutputDevices(): alphaTab.collections.List<ISynthOutputDevice>

getOutputDevice

The currently configured output device if changed via setOutputDevice . (Inherited from ISynthOutput )

JavaScript

getOutputDevice(): Promise<ISynthOutputDevice | null>

C#

System.Threading.Task<ISynthOutputDevice?> GetOutputDevice()

Kotlin

suspend fun getOutputDevice(): ISynthOutputDevice?

Returns

The custom configured output device which was set via setOutputDevice or null if the default outputDevice is used. The output device might change dynamically if devices are connected/disconnected (e.g. bluetooth headset).

loadBackingTrack

Instructs the output to load the given backing track.

JavaScript

loadBackingTrack(backingTrack: BackingTrack): void

C#

void LoadBackingTrack(BackingTrack backingTrack)

Kotlin

fun loadBackingTrack(backingTrack: BackingTrack): Unit

Parameter	Summary
backingTrackAll	The backing track to load.

open

Called when the output should be opened. (Inherited from ISynthOutput )

JavaScript

open(bufferTimeInMilliseconds: number): void

C#

void Open(double bufferTimeInMilliseconds)

Kotlin

fun open(bufferTimeInMilliseconds: Double): Unit

Parameter	Summary
bufferTimeInMillisecondsAll	(no description)

pause

Called when the output should stop the playback. (Inherited from ISynthOutput )

JavaScript

pause(): void

C#

void Pause()

Kotlin

fun pause(): Unit

play

Called when the output should start the playback. (Inherited from ISynthOutput )

JavaScript

play(): void

C#

void Play()

Kotlin

fun play(): Unit

resetSamples

Called when the samples in the output buffer should be reset. This is neeed for instance when seeking to another position. (Inherited from ISynthOutput )

JavaScript

resetSamples(): void

C#

void ResetSamples()

Kotlin

fun resetSamples(): Unit

seekTo

Instructs the output to seek to the given time position.

JavaScript

seekTo(time: number): void

C#

void SeekTo(double time)

Kotlin

fun seekTo(time: Double): Unit

Parameter	Summary
timeAll	The absolute time in milliseconds.

setOutputDevice

Changes the output device which should be used for playing the audio. (Inherited from ISynthOutput )

JavaScript

setOutputDevice(device: ISynthOutputDevice | null): Promise<void>

C#

System.Threading.Task<void> SetOutputDevice(ISynthOutputDevice? device)

Kotlin

suspend fun setOutputDevice(device: ISynthOutputDevice?): Unit

Parameter	Summary
deviceAll	The output device to use, or null to switch to the default device.