alphaTab.synth.IAlphaSynth

The public API interface for interacting with the synthesizer.

 interface IAlphaSynth

Properties

countInVolume

Gets or sets volume of the metronome during count-in. (range: 0.0-3.0, default 0.0 - no count in)

JavaScript

countInVolume: number;

C#

double CountInVolume { get; set; }

Kotlin

var countInVolume: Double

currentPosition

The latest time information of the played song.

JavaScript

readonly currentPosition: PositionChangedEventArgs;

C#

PositionChangedEventArgs CurrentPosition { get; }

Kotlin

val currentPosition: PositionChangedEventArgs

isLooping

Gets or sets whether the playback should automatically restart after it finished.

JavaScript

isLooping: boolean;

C#

bool IsLooping { get; set; }

Kotlin

var isLooping: Boolean

isReady

Gets or sets whether the synthesizer is ready for interaction. (output and worker are initialized)

JavaScript

readonly isReady: boolean;

C#

bool IsReady { get; }

Kotlin

val isReady: Boolean

isReadyForPlayback

Gets or sets whether the synthesizer is ready for playback. (output, worker are initialized, soundfont and midi are loaded)

JavaScript

readonly isReadyForPlayback: boolean;

C#

bool IsReadyForPlayback { get; }

Kotlin

val isReadyForPlayback: Boolean

loadedMidiInfo

The information about the main song loaded (does not account for "one time midis" or "count in").

JavaScript

readonly loadedMidiInfo?: PositionChangedEventArgs;

C#

PositionChangedEventArgs LoadedMidiInfo { get; }

Kotlin

val loadedMidiInfo: PositionChangedEventArgs

logLevel

Gets or sets the loging level.

JavaScript

logLevel: LogLevel;

C#

LogLevel LogLevel { get; set; }

Kotlin

var logLevel: LogLevel

masterVolume

Gets or sets the current master volume as percentage. (range: 0.0-3.0, default 1.0)

JavaScript

masterVolume: number;

C#

double MasterVolume { get; set; }

Kotlin

var masterVolume: Double

metronomeVolume

Gets or sets the metronome volume. (range: 0.0-3.0, default 0.0)

JavaScript

metronomeVolume: number;

C#

double MetronomeVolume { get; set; }

Kotlin

var metronomeVolume: Double

midiEventsPlayedFilter

Gets or sets the midi events which will trigger the midiEventsPlayed event.

JavaScript

midiEventsPlayedFilter: MidiEventType[];

C#

IList<MidiEventType> MidiEventsPlayedFilter { get; set; }

Kotlin

var midiEventsPlayedFilter: alphaTab.collections.List<MidiEventType>

output

Gets the output used by alphaSynth.

JavaScript

readonly output: ISynthOutput;

C#

ISynthOutput Output { get; }

Kotlin

val output: ISynthOutput

playbackRange

Gets or sets the range of the song that should be played. Set this to null to play the whole song.

JavaScript

playbackRange: PlaybackRange | null;

C#

PlaybackRange? PlaybackRange { get; set; }

Kotlin

var playbackRange: PlaybackRange?

playbackSpeed

Gets or sets the current playback speed as percentage. (range: 0.125-8.0, default: 1.0)

JavaScript

playbackSpeed: number;

C#

double PlaybackSpeed { get; set; }

Kotlin

var playbackSpeed: Double

ready

This event is fired when the player is ready to be interacted with.

JavaScript

readonly ready: IEventEmitter;

C#

IEventEmitter Ready { get; }

Kotlin

val ready: IEventEmitter

readyForPlayback

This event is fired when all required data for playback is loaded and ready.

JavaScript

readonly readyForPlayback: IEventEmitter;

C#

IEventEmitter ReadyForPlayback { get; }

Kotlin

val readyForPlayback: IEventEmitter

state

Gets the current player state.

JavaScript

readonly state: PlayerState;

C#

PlayerState State { get; }

Kotlin

val state: PlayerState

tickPosition

Gets or sets the position within the song in midi ticks.

JavaScript

tickPosition: number;

C#

double TickPosition { get; set; }

Kotlin

var tickPosition: Double

timePosition

Gets or sets the position within the song in milliseconds.

JavaScript

timePosition: number;

C#

double TimePosition { get; set; }

Kotlin

var timePosition: Double

Methods

applyTranspositionPitches

Applies the given transposition pitches to be used during playback.

JavaScript

applyTranspositionPitches(transpositionPitches: Map<number, number>): void

C#

void ApplyTranspositionPitches(Map<double, double> transpositionPitches)

Kotlin

fun applyTranspositionPitches(transpositionPitches: alphaTab.collections.DoubleDoubleMap<Double, Double>): Unit

Parameter	Summary
transpositionPitchesAll	a map defining the transposition pitches for midi channel.

destroy

Destroys the synthesizer and all related components

JavaScript

destroy(): void

C#

void Destroy()

Kotlin

fun destroy(): Unit

loadBackingTrack

Loads the synchronization information from the given score (used for backing tracks and external media).

JavaScript

loadBackingTrack(score: Score): void

C#

void LoadBackingTrack(Score score)

Kotlin

fun loadBackingTrack(score: Score): Unit

Parameter	Summary
scoreAll	(no description)

loadMidiFile

Loads the given midi file structure.

JavaScript

loadMidiFile(midi: MidiFile): void

C#

void LoadMidiFile(MidiFile midi)

Kotlin

fun loadMidiFile(midi: MidiFile): Unit

Parameter	Summary
midiAll	(no description)

loadSoundFont

Loads a soundfont from the given data

JavaScript

loadSoundFont(data: Uint8Array, append: boolean): void

C#

void LoadSoundFont(Uint8Array data, bool append)

Kotlin

fun loadSoundFont(data: Uint8Array, append: Boolean): Unit

Parameter	Summary
dataAll	a byte array to load the data from
appendAll	Whether to fully replace or append the data from the given soundfont.

pause

Pauses the playback if was running

JavaScript

pause(): void

C#

void Pause()

Kotlin

fun pause(): Unit

play

Starts the playback if possible

JavaScript

play(): boolean

C#

bool Play()

Kotlin

fun play(): Boolean

Returns

true if the playback was started, otherwise false. Reasons for not starting can be that the player is not ready or already playing.

playOneTimeMidiFile

Stops any ongoing playback and plays the given midi file instead.

JavaScript

playOneTimeMidiFile(midi: MidiFile): void

C#

void PlayOneTimeMidiFile(MidiFile midi)

Kotlin

fun playOneTimeMidiFile(midi: MidiFile): Unit

Parameter	Summary
midiAll	The midi file to play

playPause

Starts the playback if possible, pauses the playback if was running

JavaScript

playPause(): void

C#

void PlayPause()

Kotlin

fun playPause(): Unit

resetChannelStates

Resets the mute/solo state of all channels

JavaScript

resetChannelStates(): void

C#

void ResetChannelStates()

Kotlin

fun resetChannelStates(): Unit

resetSoundFonts

Resets all loaded soundfonts as if they were not loaded.

JavaScript

resetSoundFonts(): void

C#

void ResetSoundFonts()

Kotlin

fun resetSoundFonts(): Unit

setChannelMute

Sets the mute state of a channel.

JavaScript

setChannelMute(channel: number, mute: boolean): void

C#

void SetChannelMute(double channel, bool mute)

Kotlin

fun setChannelMute(channel: Double, mute: Boolean): Unit

Parameter	Summary
channelAll	The channel number
muteAll	true if the channel should be muted, otherwise false.

setChannelSolo

Gets the solo state of a channel.

JavaScript

setChannelSolo(channel: number, solo: boolean): void

C#

void SetChannelSolo(double channel, bool solo)

Kotlin

fun setChannelSolo(channel: Double, solo: Boolean): Unit

Parameter	Summary
channelAll	The channel number
soloAll	true if the channel should be played solo, otherwise false.

setChannelTranspositionPitch

Sets the transposition pitch of a given channel. This pitch is additionally applied beside the ones applied already via applyTranspositionPitches .

JavaScript

setChannelTranspositionPitch(channel: number, semitones: number): void

C#

void SetChannelTranspositionPitch(double channel, double semitones)

Kotlin

fun setChannelTranspositionPitch(channel: Double, semitones: Double): Unit

Parameter	Summary
channelAll	The channel number
semitonesAll	The number of semitones to apply as pitch offset.

setChannelVolume

Gets or sets the current and initial volume of the given channel.

JavaScript

setChannelVolume(channel: number, volume: number): void

C#

void SetChannelVolume(double channel, double volume)

Kotlin

fun setChannelVolume(channel: Double, volume: Double): Unit

Parameter	Summary
channelAll	The channel number.
volumeAll	The volume of of the channel (0.0-1.0)

stop

Stopps the playback

JavaScript

stop(): void

C#

void Stop()

Kotlin

fun stop(): Unit

updateSyncPoints

Updates the points used to synchronize the backing track with the synthesized audio for correct cursor placement.

JavaScript

updateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void

C#

void UpdateSyncPoints(IList<BackingTrackSyncPoint> syncPoints)

Kotlin

fun updateSyncPoints(syncPoints: alphaTab.collections.List<BackingTrackSyncPoint>): Unit

Parameter	Summary
syncPointsAll	(no description)

Events

finished

This event is fired when the playback of the whole song finished.

This event is fired when the playback of the whole song finished.

JavaScript

readonly finished: IEventEmitter;

C#

IEventEmitter Finished { get; }

Kotlin

val finished: IEventEmitter

midiEventsPlayed

The event is fired when certain midi events were sent to the audio output device for playback.

The event is fired when certain midi events were sent to the audio output device for playback.

JavaScript

readonly midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;

C#

IEventEmitterOfT<MidiEventsPlayedEventArgs> MidiEventsPlayed { get; }

Kotlin

val midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>

midiLoaded

This event is fired when the Midi file needed for playback was loaded.

This event is fired when the Midi file needed for playback was loaded.

JavaScript

readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;

C#

IEventEmitterOfT<PositionChangedEventArgs> MidiLoaded { get; }

Kotlin

val midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>

midiLoadFailed

This event is fired when the loading of the Midi file failed.

This event is fired when the loading of the Midi file failed.

JavaScript

readonly midiLoadFailed: IEventEmitterOfT<Error>;

C#

IEventEmitterOfT<System.Exception> MidiLoadFailed { get; }

Kotlin

val midiLoadFailed: IEventEmitterOfT<kotlin.Throwable>

playbackRangeChanged

The event is fired when the playback range within the player was updated.

The event is fired when the playback range within the player was updated.

JavaScript

readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;

C#

IEventEmitterOfT<PlaybackRangeChangedEventArgs> PlaybackRangeChanged { get; }

Kotlin

val playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>

positionChanged

This event is fired when the current playback position of/ the song changed.

This event is fired when the current playback position of/ the song changed.

JavaScript

readonly positionChanged: IEventEmitterOfT<PositionChangedEventArgs>;

C#

IEventEmitterOfT<PositionChangedEventArgs> PositionChanged { get; }

Kotlin

val positionChanged: IEventEmitterOfT<PositionChangedEventArgs>

soundFontLoaded

This event is fired when the SoundFont needed for playback was loaded.

This event is fired when the SoundFont needed for playback was loaded.

JavaScript

readonly soundFontLoaded: IEventEmitter;

C#

IEventEmitter SoundFontLoaded { get; }

Kotlin

val soundFontLoaded: IEventEmitter

soundFontLoadFailed

This event is fired when the loading of the SoundFont failed.

This event is fired when the loading of the SoundFont failed.

JavaScript

readonly soundFontLoadFailed: IEventEmitterOfT<Error>;

C#

IEventEmitterOfT<System.Exception> SoundFontLoadFailed { get; }

Kotlin

val soundFontLoadFailed: IEventEmitterOfT<kotlin.Throwable>

stateChanged

This event is fired when the playback state changed.

This event is fired when the playback state changed.

JavaScript

readonly stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;

C#

IEventEmitterOfT<PlayerStateChangedEventArgs> StateChanged { get; }

Kotlin

val stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>