Class JukeboxState

Namespace

S1API.Audio

Assembly

S1API.dll

An immutable snapshot of a jukebox's current native state.

public sealed class JukeboxState

Inheritance

object

JukeboxState

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

CurrentTrack

Gets the current track, or null when the native jukebox has no current track.

public JukeboxTrack? CurrentTrack { get; }

Property Value

JukeboxTrack

CurrentTrackOrderIndex

Gets the current position in the native playback queue.

public int CurrentTrackOrderIndex { get; }

Property Value

int

CurrentTrackTime

Gets the elapsed time of the current track in seconds.

public float CurrentTrackTime { get; }

Property Value

float

IsPlaying

Gets whether the jukebox is playing.

public bool IsPlaying { get; }

Property Value

bool

NormalizedVolume

Gets the native volume normalized by the game's maximum volume.

public float NormalizedVolume { get; }

Property Value

float

RepeatMode

Gets the native repeat mode.

public JukeboxRepeatMode RepeatMode { get; }

Property Value

JukeboxRepeatMode

Shuffle

Gets whether the native playback queue is shuffled.

public bool Shuffle { get; }

Property Value

bool

Sync

Gets whether the jukebox synchronizes with other native jukeboxes.

public bool Sync { get; }

Property Value

bool

Volume

Gets the current native volume value.

public int Volume { get; }

Property Value

int