Skip to main content

alphaTab.synth.ISynthOutput

Description

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.

sampleRate

Gets the sample rate required by the output.

sampleRequest

Fired when the output needs more samples to be played.

samplesPlayed

Fired when a certain number of samples have been played.

Methods

activate()

Activates the output component.

addSamples(Float32Array)

Called when samples have been synthesized and should be added to the playback buffer.

destroy()

Requests the output to destroy itself.

enumerateOutputDevices()

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

getOutputDevice()

The currently configured output device if changed via setOutputDevice.

open(number)

Called when the output should be opened.

pause()

Called when the output should stop the playback.

play()

Called when the output should start the playback.

resetSamples()

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

setOutputDevice(ISynthOutputDevice | null)

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