alphaTab.synth.AlphaSynth

This is the main synthesizer component which can be used to play a MidiFile via a ISynthOutput .

 class AlphaSynth extends AlphaSynthBase

Properties

`countInVolume`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

countInVolume: number;

double CountInVolume { get; set; }

var countInVolume: Double

`currentPosition`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly currentPosition: PositionChangedEventArgs;

PositionChangedEventArgs CurrentPosition { get; }

val currentPosition: PositionChangedEventArgs

`finished`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly finished: IEventEmitter;

IEventEmitter Finished { get; }

val finished: IEventEmitter

`isLooping`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

isLooping: boolean;

bool IsLooping { get; set; }

var isLooping: Boolean

`isReady`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

isReady: boolean;

bool IsReady { get; set; }

var isReady: Boolean

`isReadyForPlayback`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly isReadyForPlayback: boolean;

bool IsReadyForPlayback { get; }

val isReadyForPlayback: Boolean

`loadedMidiInfo`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly loadedMidiInfo: PositionChangedEventArgs | undefined;

PositionChangedEventArgs? LoadedMidiInfo { get; }

val loadedMidiInfo: PositionChangedEventArgs?

`logLevel`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

logLevel: LogLevel;

LogLevel LogLevel { get; set; }

var logLevel: LogLevel

`masterVolume`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

masterVolume: number;

double MasterVolume { get; set; }

var masterVolume: Double

`metronomeVolume`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

metronomeVolume: number;

double MetronomeVolume { get; set; }

var metronomeVolume: Double

`midiEventsPlayed`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;

IEventEmitterOfT<MidiEventsPlayedEventArgs> MidiEventsPlayed { get; }

val midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>

`midiEventsPlayedFilter`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

midiEventsPlayedFilter: MidiEventType[];

IList<MidiEventType> MidiEventsPlayedFilter { get; set; }

var midiEventsPlayedFilter: alphaTab.collections.List<MidiEventType>

`midiLoaded`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;

IEventEmitterOfT<PositionChangedEventArgs> MidiLoaded { get; }

val midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>

`midiLoadFailed`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly midiLoadFailed: IEventEmitterOfT<Error>;

IEventEmitterOfT<System.Exception> MidiLoadFailed { get; }

val midiLoadFailed: IEventEmitterOfT<kotlin.Throwable>

`output`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly output: ISynthOutput;

ISynthOutput Output { get; }

val output: ISynthOutput

`playbackRange`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

playbackRange: PlaybackRange | null;

PlaybackRange? PlaybackRange { get; set; }

var playbackRange: PlaybackRange?

`playbackRangeChanged`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;

IEventEmitterOfT<PlaybackRangeChangedEventArgs> PlaybackRangeChanged { get; }

val playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>

`playbackSpeed`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

playbackSpeed: number;

double PlaybackSpeed { get; set; }

var playbackSpeed: Double

`positionChanged`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly positionChanged: IEventEmitterOfT<PositionChangedEventArgs>;

IEventEmitterOfT<PositionChangedEventArgs> PositionChanged { get; }

val positionChanged: IEventEmitterOfT<PositionChangedEventArgs>

`ready`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly ready: IEventEmitter;

IEventEmitter Ready { get; }

val ready: IEventEmitter

`readyForPlayback`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly readyForPlayback: IEventEmitter;

IEventEmitter ReadyForPlayback { get; }

val readyForPlayback: IEventEmitter

`soundFontLoaded`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly soundFontLoaded: IEventEmitter;

IEventEmitter SoundFontLoaded { get; }

val soundFontLoaded: IEventEmitter

`soundFontLoadFailed`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly soundFontLoadFailed: IEventEmitterOfT<Error>;

IEventEmitterOfT<System.Exception> SoundFontLoadFailed { get; }

val soundFontLoadFailed: IEventEmitterOfT<kotlin.Throwable>

`state`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

state: PlayerState;

PlayerState State { get; set; }

var state: PlayerState

`stateChanged`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

readonly stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;

IEventEmitterOfT<PlayerStateChangedEventArgs> StateChanged { get; }

val stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>

`tickPosition`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

tickPosition: number;

double TickPosition { get; set; }

var tickPosition: Double

`timePosition`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

timePosition: number;

double TimePosition { get; set; }

var timePosition: Double

Methods

`applyTranspositionPitches`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void ApplyTranspositionPitches(Map<double, double> transpositionPitches)

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

Parameter	Summary
`transpositionPitchesAll`	(no description)

`destroy`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

destroy(): void

void Destroy()

fun destroy(): Unit

`exportAudio`

Creates a new audio exporter, initialized with the given data.

JavaScript
C#
Kotlin

exportAudio(options: AudioExportOptions, midi: MidiFile, syncPoints: BackingTrackSyncPoint[], mainTranspositionPitches: Map<number, number>): IAlphaSynthAudioExporter

IAlphaSynthAudioExporter ExportAudio(AudioExportOptions options, MidiFile midi, IList<BackingTrackSyncPoint> syncPoints, Map<double, double> mainTranspositionPitches)

fun exportAudio(options: AudioExportOptions, midi: MidiFile, syncPoints: alphaTab.collections.List<BackingTrackSyncPoint>, mainTranspositionPitches: alphaTab.collections.DoubleDoubleMap<Double, Double>): IAlphaSynthAudioExporter

Parameter	Summary
`optionsAll`	The export options to use. The track volume and transposition pitches must lists must be filled with midi channels.
`midiAll`	The midi file to use.
`syncPointsAll`	The sync points to use
`mainTranspositionPitchesAll`	(no description)

`loadBackingTrack`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

loadBackingTrack(_score: Score): void

void LoadBackingTrack(Score _score)

fun loadBackingTrack(_score: Score): Unit

Parameter	Summary
`_scoreAll`	(no description)

`loadMidiFile`

Loads the given midi file for playback. (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

loadMidiFile(midi: MidiFile): void

void LoadMidiFile(MidiFile midi)

fun loadMidiFile(midi: MidiFile): Unit

Parameter	Summary
`midiAll`	The midi file to load

`loadSoundFont`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void LoadSoundFont(Uint8Array data, bool append)

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

Parameter	Summary
`dataAll`	(no description)
`appendAll`	(no description)

`pause`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

pause(): void

void Pause()

fun pause(): Unit

`play`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

play(): boolean

bool Play()

fun play(): Boolean

`playOneTimeMidiFile`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

playOneTimeMidiFile(midi: MidiFile): void

void PlayOneTimeMidiFile(MidiFile midi)

fun playOneTimeMidiFile(midi: MidiFile): Unit

Parameter	Summary
`midiAll`	(no description)

`playPause`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

playPause(): void

void PlayPause()

fun playPause(): Unit

`resetChannelStates`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

resetChannelStates(): void

void ResetChannelStates()

fun resetChannelStates(): Unit

`resetSoundFonts`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

resetSoundFonts(): void

void ResetSoundFonts()

fun resetSoundFonts(): Unit

`setChannelMute`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void SetChannelMute(double channel, bool mute)

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

Parameter	Summary
`channelAll`	(no description)
`muteAll`	(no description)

`setChannelSolo`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void SetChannelSolo(double channel, bool solo)

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

Parameter	Summary
`channelAll`	(no description)
`soloAll`	(no description)

`setChannelTranspositionPitch`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void SetChannelTranspositionPitch(double channel, double semitones)

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

Parameter	Summary
`channelAll`	(no description)
`semitonesAll`	(no description)

`setChannelVolume`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

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

void SetChannelVolume(double channel, double volume)

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

Parameter	Summary
`channelAll`	(no description)
`volumeAll`	(no description)

`stop`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

stop(): void

void Stop()

fun stop(): Unit

`updateSyncPoints`

(no description) (Inherited from AlphaSynthBase )

JavaScript
C#
Kotlin

updateSyncPoints(_syncPoints: BackingTrackSyncPoint[]): void

void UpdateSyncPoints(IList<BackingTrackSyncPoint> _syncPoints)

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

Parameter	Summary
`_syncPointsAll`	(no description)

Properties​

countInVolume​

currentPosition​

finished​

isLooping​

isReady​

isReadyForPlayback​

loadedMidiInfo​

logLevel​

masterVolume​

metronomeVolume​

midiEventsPlayed​

midiEventsPlayedFilter​

midiLoaded​

midiLoadFailed​

output​

playbackRange​

playbackRangeChanged​

playbackSpeed​

positionChanged​

ready​

readyForPlayback​

soundFontLoaded​

soundFontLoadFailed​

state​

stateChanged​

tickPosition​

timePosition​

Methods​

Properties

`countInVolume`

`currentPosition`

`finished`

`isLooping`

`isReady`

`isReadyForPlayback`

`loadedMidiInfo`

`logLevel`

`masterVolume`

`metronomeVolume`

`midiEventsPlayed`

`midiEventsPlayedFilter`

`midiLoaded`

`midiLoadFailed`

`output`

`playbackRange`

`playbackRangeChanged`

`playbackSpeed`

`positionChanged`

`ready`

`readyForPlayback`

`soundFontLoaded`

`soundFontLoadFailed`

`state`

`stateChanged`

`tickPosition`

`timePosition`

Methods