Skip to main content

alphaTab.PlayerSettings

Description

The player settings control how the audio playback and UI is behaving.

 class PlayerSettings

Properties

bufferTimeInMilliseconds

The number of milliseconds the player should buffer.

enableAnimatedBeatCursor

Whether the beat cursor should be animated or just ticking.

enableCursor

Whether playback cursors should be displayed.

enableElementHighlighting

Whether the notation elements of the currently played beat should be highlighted.

enablePlayer

Whether the player should be enabled.

enableUserInteraction

Whether the default user interaction behavior should be active or not.

nativeBrowserSmoothScroll

Whether the native browser smooth scroll mechanism should be used over a custom animation.

outputMode

The mode used for playing audio samples

playTripletFeel

Whether the triplet feel should be played or only displayed.

scrollElement

The element to apply the scrolling on.

scrollMode

The mode how to scroll.

scrollOffsetX

The X-offset to add when scrolling.

scrollOffsetY

The Y-offset to add when scrolling.

scrollSpeed

How fast the scrolling to the new position should happen.

slide

The slide settings allow control how the different slide types are generated for audio.

songBookBendDuration

The bend duration in milliseconds for songbook bends.

songBookDipDuration

The duration of whammy dips in milliseconds for songbook whammys.

soundFont

The sound font file to load for the player.

vibrato

The Vibrato settings allow control how the different vibrato types are generated for audio.