AudioStreamInteractive

int clip_count = 0

Amount of clips contained in this interactive player.

int initial_clip = 0

Index of the initial clip, which will be played first when this stream is played.

void add_transition(int from_clip, int to_clip, int from_time, int to_time, int fade_mode, float fade_beats, bool use_filler_clip = false, int filler_clip = -1, bool hold_previous = false)

Add a transition between two clips. Provide the indices of the source and destination clips, or use the CLIP_ANY constant to indicate that transition happens to/from any clip to this one. * from_time indicates the moment in the current clip the transition will begin after triggered. * to_time indicates the time in the next clip that the playback will start from. * fade_mode indicates how the fade will happen between clips. If unsure, just use FADE_AUTOMATIC which uses the most common type of fade for each situation. * fade_beats indicates how many beats the fade will take. Using decimals is allowed. * use_filler_clip indicates that there will be a filler clip used between the source and destination clips. * filler_clip the index of the filler clip. * If hold_previous is used, then this clip will be remembered. This can be used together with AUTO_ADVANCE_RETURN_TO_HOLD to return to this clip after another is done playing.

void erase_transition(int from_clip, int to_clip)

Erase a transition by providing from_clip and to_clip clip indices. CLIP_ANY can be used for either argument or both.

int get_clip_auto_advance(int clip_index) const

Return whether a clip has auto-advance enabled. See set_clip_auto_advance().

int get_clip_auto_advance_next_clip(int clip_index) const

Return the clip towards which the clip referenced by clip_index will auto-advance to.

StringName get_clip_name(int clip_index) const

Return the name of a clip.

AudioStream get_clip_stream(int clip_index) const

Return the AudioStream associated with a clip.

float get_transition_fade_beats(int from_clip, int to_clip) const

Return the time (in beats) for a transition (see add_transition()).

int get_transition_fade_mode(int from_clip, int to_clip) const

Return the mode for a transition (see add_transition()).

int get_transition_filler_clip(int from_clip, int to_clip) const

Return the filler clip for a transition (see add_transition()).

int get_transition_from_time(int from_clip, int to_clip) const

Return the source time position for a transition (see add_transition()).

PackedInt32Array get_transition_list() const

Return the list of transitions (from, to interleaved).

int get_transition_to_time(int from_clip, int to_clip) const

Return the destination time position for a transition (see add_transition()).

bool has_transition(int from_clip, int to_clip) const

Returns true if a given transition exists (was added via add_transition()).

bool is_transition_holding_previous(int from_clip, int to_clip) const

Return whether a transition uses the hold previous functionality (see add_transition()).

bool is_transition_using_filler_clip(int from_clip, int to_clip) const

Return whether a transition uses the filler clip functionality (see add_transition()).

void set_clip_auto_advance(int clip_index, int mode)

Set whether a clip will auto-advance by changing the auto-advance mode.

void set_clip_auto_advance_next_clip(int clip_index, int auto_advance_next_clip)

Set the index of the next clip towards which this clip will auto advance to when finished. If the clip being played loops, then auto-advance will be ignored.

void set_clip_name(int clip_index, StringName name)

Set the name of the current clip (for easier identification).

void set_clip_stream(int clip_index, AudioStream stream)

Set the AudioStream associated with the current clip.

TRANSITION_FROM_TIME_IMMEDIATE = 0

Enum: TransitionFromTime

Start transition as soon as possible, don't wait for any specific time position.

TRANSITION_FROM_TIME_NEXT_BEAT = 1

Enum: TransitionFromTime

Transition when the clip playback position reaches the next beat.

TRANSITION_FROM_TIME_NEXT_BAR = 2

Enum: TransitionFromTime

Transition when the clip playback position reaches the next bar.

TRANSITION_FROM_TIME_END = 3

Enum: TransitionFromTime

Transition when the current clip finished playing.

TRANSITION_TO_TIME_SAME_POSITION = 0

Enum: TransitionToTime

Transition to the same position in the destination clip. This is useful when both clips have exactly the same length and the music should fade between them.

TRANSITION_TO_TIME_START = 1

Enum: TransitionToTime

Transition to the start of the destination clip.

FADE_DISABLED = 0

Enum: FadeMode

Do not use fade for the transition. This is useful when transitioning from a clip-end to clip-beginning, and each clip has their begin/end.

FADE_IN = 1

Enum: FadeMode

Use a fade-in in the next clip, let the current clip finish.

FADE_OUT = 2

Enum: FadeMode

Use a fade-out in the current clip, the next clip will start by itself.

FADE_CROSS = 3

Enum: FadeMode

Use a cross-fade between clips.

FADE_AUTOMATIC = 4

Enum: FadeMode

Use automatic fade logic depending on the transition from/to. It is recommended to use this by default.

AUTO_ADVANCE_DISABLED = 0

Enum: AutoAdvanceMode

Disable auto-advance (default).

AUTO_ADVANCE_ENABLED = 1

Enum: AutoAdvanceMode

Enable auto-advance, a clip must be specified.

AUTO_ADVANCE_RETURN_TO_HOLD = 2

Enum: AutoAdvanceMode

Enable auto-advance, but instead of specifying a clip, the playback will return to hold (see add_transition()).

CLIP_ANY = -1

This constant describes that any clip is valid for a specific transition as either source or destination.