IAlphaSynth Interface

Summary

The public API interface for interacting with the synthesizer.
Namespace
AlphaTab.Audio.Synth
Implementing Types
graph TD Type["IAlphaSynth"] class Type type-node Type-.->Implementing0["AlphaSynth"] click Implementing0 "/master/api/AlphaTab.Audio.Synth/AlphaSynth"

Syntax

public interface IAlphaSynth

Properties

Name Value Summary
IsLooping bool
Gets or sets whether the playback should automatically restart after it finished.
IsReady bool
Gets or sets whether the synthesizer is ready for interaction. (output and worker are initialized)
IsReadyForPlayback bool
Gets or sets whether the synthesizer is ready for playback. (output, worker are initialized, soundfont and midi are loaded)
LogLevel LogLevel
Gets or sets the loging level.
MasterVolume float
Gets or sets the current master volume as percentage. (range: 0.0-3.0, default 1.0)
MetronomeVolume float
Gets or sets the metronome volume. (range: 0.0-3.0, default 0.0)
PlaybackRange PlaybackRange
Gets or sets the range of the song that should be played. Set this to null to play the whole song.
PlaybackSpeed double
Gets or sets the current playback speed as percentage. (range: 0.125-8.0, default: 1.0)
State PlayerState
Gets the current player state.
TickPosition int
Gets or sets the position within the song in midi ticks.
TimePosition double
Gets or sets the position within the song in milliseconds.

Methods

Name Value Summary
LoadSoundFont(byte[]) void
Loads a soundfont from the given data
Pause() void
Pauses the playback if was running
Play() void
Starts the playback if possible
PlayPause() void
Starts the playback if possible, pauses the playback if was running
ResetChannelStates() void
Resets the mute/solo state of all channels
SetChannelMute(int, bool) void
Gets the mute state of a channel.
SetChannelProgram(int, byte) void
Gets or sets the current and initial program of the given channel.
SetChannelSolo(int, bool) void
Gets the solo state of a channel.
SetChannelVolume(int, double) void
Gets or sets the current and initial volume of the given channel.
Stop() void
Stopps the playback