alphaTab.synth.BackingTrackSyncPoint

Rerpresents a point to sync the alphaTab time axis with an external backing track.

 class BackingTrackSyncPoint

Properties

masterBarIndex

The index of the masterbar to which this sync point belongs to. This property is purely informative for external use like in editors. It has no impact to the synchronization itself.

JavaScript

masterBarIndex: number;

C#

double MasterBarIndex { get; set; }

Kotlin

var masterBarIndex: Double

masterBarOccurence

The occurence of the masterbar to which this sync point belongs to. The occurence is 0-based and increases with every repeated play of a masterbar (e.g. on repeats or jumps). This property is purely informative for external use like in editors. It has no impact to the synchronization itself.

JavaScript

masterBarOccurence: number;

C#

double MasterBarOccurence { get; set; }

Kotlin

var masterBarOccurence: Double

syncBpm

The BPM the song will have virtually after this sync point to align the external media time axis with the one from the synthesizer.

JavaScript

syncBpm: number;

C#

double SyncBpm { get; set; }

Kotlin

var syncBpm: Double

syncTime

The millisecond time in the external media marking the synchronization point.

JavaScript

syncTime: number;

C#

double SyncTime { get; set; }

Kotlin

var syncTime: Double

synthBpm

The BPM the synthesizer has at the exact tick position of this sync point.

JavaScript

synthBpm: number;

C#

double SynthBpm { get; set; }

Kotlin

var synthBpm: Double

synthTick

The midi tick position of the synthesizer when this sync point is reached.

JavaScript

synthTick: number;

C#

double SynthTick { get; set; }

Kotlin

var synthTick: Double

synthTime

The millisecond time position of the synthesizer when this sync point is reached.

JavaScript

synthTime: number;

C#

double SynthTime { get; set; }

Kotlin

var synthTime: Double

Methods

updateSyncBpm

Updates the synchronization BPM that will apply after this sync point.

JavaScript

updateSyncBpm(nextSyncPointSynthTime: number, nextSyncPointSyncTime: number): void

C#

void UpdateSyncBpm(double nextSyncPointSynthTime, double nextSyncPointSyncTime)

Kotlin

fun updateSyncBpm(nextSyncPointSynthTime: Double, nextSyncPointSyncTime: Double): Unit

Parameter	Summary
nextSyncPointSynthTimeAll	The synthesizer time of the next sync point after this one.
nextSyncPointSyncTimeAll	The synchronization time of the next sync point after this one.