Properties

📌 Summary Table

Property
Type
Short Description

Using

bool

True if the playlist is in use, even if it’s paused.

Playing

bool

True if the playlist is currently playing.

Paused

bool

True if the playlist is paused, ignoring any fade-out.

Volume

float

Current playlist volume (value between 0 and 1).

PlayingTime

float

Total time (in seconds) the playlist has been playing.

CurrentLoopCycleTime

float

Current time (in seconds) of the active loop cycle.

CompletedLoopCycles

int

Number of completed loop cycles.

CurrentClipDuration

float

Duration (in seconds) of the clip currently playing.

PlayListDuration

float

Total duration (sum of all clips) of the playlist.

ReproducedTracks

float

Number of tracks that have been played since the playlist started.

CurrentPlaylistClip

AudioClip

Reference to the clip that is currently playing in the playlist.

NextPlaylistClip

AudioClip

Reference to the clip that will play next in the playlist.

PlaylistClipsTags

string[]

Array of clip tags in the playlist, in playback order.


📘 Detailed Description

bool Using

Returns true if the playlist is in use. This includes both active playback and paused states, as long as the playlist remains bound to an AudioSource.


bool Playing

Returns true if a clip from the playlist is actively playing. If the playlist is paused or stopped, this property will be false.


bool Paused

Returns true if the playlist is paused, regardless of any fade-out that may have been applied.


float Volume

Represents the current volume of the playlist. Values range from 0 (silent) to 1 (full volume).


float PlayingTime

Total time in seconds that the playlist has been playing since it was last started.


float CurrentLoopCycleTime

Elapsed time in seconds of the current loop cycle. If looping is disabled, this equals the play time of the current clip.


int CompletedLoopCycles

Number of full loop cycles completed since the playlist began. Increments only when looping is enabled.


float CurrentClipDuration

Duration in seconds of the clip currently playing within the playlist. Useful for timing or visual synchronizations.


float PlayListDuration

Sum of the durations of all clips in the playlist. This total remains constant even if not all tracks have been played yet.


float ReproducedTracks

Number of tracks that have finished playing since the playlist started. Increases each time a clip completes.


AudioClip CurrentPlaylistClip

Direct reference to the AudioClip currently being played in the playlist.


AudioClip NextPlaylistClip

Reference to the next AudioClip that will play when the current one ends.


string[] PlaylistClipsTags

Array containing the tags of all clips in the playlist, in the exact order they will be played.


Last updated