alphaTab.synth.ISynthOutput

This is the base interface for output devices which can request and playback audio samples.

 interface ISynthOutput

Properties

ready

Fired when the output has been successfully opened and is ready to play samples.

JavaScript

readonly ready: IEventEmitter;

C#

IEventEmitter Ready { get; }

Kotlin

val ready: IEventEmitter

sampleRate

Gets the sample rate required by the output.

JavaScript

readonly sampleRate: number;

C#

double SampleRate { get; }

Kotlin

val sampleRate: Double

sampleRequest

Fired when the output needs more samples to be played.

JavaScript

readonly sampleRequest: IEventEmitter;

C#

IEventEmitter SampleRequest { get; }

Kotlin

val sampleRequest: IEventEmitter

samplesPlayed

Fired when a certain number of samples have been played.

JavaScript

readonly samplesPlayed: IEventEmitterOfT<number>;

C#

IEventEmitterOfT<double> SamplesPlayed { get; }

Kotlin

val samplesPlayed: IEventEmitterOfT<Double>

Methods

activate

Activates the output component.

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.

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.

JavaScript

destroy(): void

C#

void Destroy()

Kotlin

fun destroy(): Unit

enumerateOutputDevices

Loads and lists the available output devices. Will request permissions if needed.

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 .

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).

open

Called when the output should be opened.

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.

JavaScript

pause(): void

C#

void Pause()

Kotlin

fun pause(): Unit

play

Called when the output should start the playback.

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.

JavaScript

resetSamples(): void

C#

void ResetSamples()

Kotlin

fun resetSamples(): Unit

setOutputDevice

Changes the output device which should be used for playing the audio.

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.