AudioStreamInteractive

Documentation

Overview

Package AudioStreamInteractive provides methods for working with AudioStreamInteractive object instances.

Index

• type Advanced
• type Any
• type AutoAdvanceMode
• type FadeMode
• type Instance
  • func New() Instance
  • func (self Instance) AddTransition(from_clip int, to_clip int, ...)
  • func (self Instance) AsAudioStream() AudioStream.Instance
  • func (self Instance) AsAudioStreamInteractive() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) ClipCount() int
  • func (self Instance) EraseTransition(from_clip int, to_clip int)
  • func (self Instance) GetClipAutoAdvance(clip_index int) gdclass.AudioStreamInteractiveAutoAdvanceMode
  • func (self Instance) GetClipAutoAdvanceNextClip(clip_index int) int
  • func (self Instance) GetClipName(clip_index int) string
  • func (self Instance) GetClipStream(clip_index int) [1]gdclass.AudioStream
  • func (self Instance) GetTransitionFadeBeats(from_clip int, to_clip int) Float.X
  • func (self Instance) GetTransitionFadeMode(from_clip int, to_clip int) gdclass.AudioStreamInteractiveFadeMode
  • func (self Instance) GetTransitionFillerClip(from_clip int, to_clip int) int
  • func (self Instance) GetTransitionFromTime(from_clip int, to_clip int) gdclass.AudioStreamInteractiveTransitionFromTime
  • func (self Instance) GetTransitionList() []int32
  • func (self Instance) GetTransitionToTime(from_clip int, to_clip int) gdclass.AudioStreamInteractiveTransitionToTime
  • func (self Instance) HasTransition(from_clip int, to_clip int) bool
  • func (self Instance) InitialClip() int
  • func (self Instance) IsTransitionHoldingPrevious(from_clip int, to_clip int) bool
  • func (self Instance) IsTransitionUsingFillerClip(from_clip int, to_clip int) bool
  • func (self Instance) SetClipAutoAdvance(clip_index int, mode gdclass.AudioStreamInteractiveAutoAdvanceMode)
  • func (self Instance) SetClipAutoAdvanceNextClip(clip_index int, auto_advance_next_clip int)
  • func (self Instance) SetClipCount(value int)
  • func (self Instance) SetClipName(clip_index int, name string)
  • func (self Instance) SetClipStream(clip_index int, stream [1]gdclass.AudioStream)
  • func (self Instance) SetInitialClip(value int)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type TransitionFromTime
• type TransitionToTime

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsAudioStreamInteractive() Instance
}

type AutoAdvanceMode

type AutoAdvanceMode = gdclass.AudioStreamInteractiveAutoAdvanceMode //gd:AudioStreamInteractive.AutoAdvanceMode

const (
	/*Disable auto-advance (default).*/
	AutoAdvanceDisabled AutoAdvanceMode = 0
	/*Enable auto-advance, a clip must be specified.*/
	AutoAdvanceEnabled AutoAdvanceMode = 1
	/*Enable auto-advance, but instead of specifying a clip, the playback will return to hold (see [method add_transition]).*/
	AutoAdvanceReturnToHold AutoAdvanceMode = 2
)

type FadeMode

type FadeMode = gdclass.AudioStreamInteractiveFadeMode //gd:AudioStreamInteractive.FadeMode

const (
	/*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.*/
	FadeDisabled FadeMode = 0
	/*Use a fade-in in the next clip, let the current clip finish.*/
	FadeIn FadeMode = 1
	/*Use a fade-out in the current clip, the next clip will start by itself.*/
	FadeOut FadeMode = 2
	/*Use a cross-fade between clips.*/
	FadeCross FadeMode = 3
	/*Use automatic fade logic depending on the transition from/to. It is recommended to use this by default.*/
	FadeAutomatic FadeMode = 4
)

type Instance

type Instance [1]gdclass.AudioStreamInteractive

This is an audio stream that can playback music interactively, combining clips and a transition table. Clips must be added first, and the transition rules via the [method add_transition]. Additionally, this stream export a property parameter to control the playback via [AudioStreamPlayer], [AudioStreamPlayer2D], or [AudioStreamPlayer3D]. The way this is used is by filling a number of clips, then configuring the transition table. From there, clips are selected for playback and the music will smoothly go from the current to the new one while using the corresponding transition rule defined in the transition table.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddTransition

func (self Instance) AddTransition(from_clip int, to_clip int, from_time gdclass.AudioStreamInteractiveTransitionFromTime, to_time gdclass.AudioStreamInteractiveTransitionToTime, fade_mode gdclass.AudioStreamInteractiveFadeMode, fade_beats Float.X)

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

func (Instance) AsAudioStream

func (self Instance) AsAudioStream() AudioStream.Instance

func (Instance) AsAudioStreamInteractive

func (self Instance) AsAudioStreamInteractive() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) ClipCount

func (self Instance) ClipCount() int

func (Instance) EraseTransition

func (self Instance) EraseTransition(from_clip int, to_clip int)

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

func (Instance) GetClipAutoAdvance

func (self Instance) GetClipAutoAdvance(clip_index int) gdclass.AudioStreamInteractiveAutoAdvanceMode

Return whether a clip has auto-advance enabled. See [method set_clip_auto_advance].

func (Instance) GetClipAutoAdvanceNextClip

func (self Instance) GetClipAutoAdvanceNextClip(clip_index int) int

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

func (Instance) GetClipName

func (self Instance) GetClipName(clip_index int) string

Return the name of a clip.

func (Instance) GetClipStream

func (self Instance) GetClipStream(clip_index int) [1]gdclass.AudioStream

Return the [AudioStream] associated with a clip.

func (Instance) GetTransitionFadeBeats

func (self Instance) GetTransitionFadeBeats(from_clip int, to_clip int) Float.X

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

func (Instance) GetTransitionFadeMode

func (self Instance) GetTransitionFadeMode(from_clip int, to_clip int) gdclass.AudioStreamInteractiveFadeMode

Return the mode for a transition (see [method add_transition]).

func (Instance) GetTransitionFillerClip

func (self Instance) GetTransitionFillerClip(from_clip int, to_clip int) int

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

func (Instance) GetTransitionFromTime

func (self Instance) GetTransitionFromTime(from_clip int, to_clip int) gdclass.AudioStreamInteractiveTransitionFromTime

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

func (Instance) GetTransitionList

func (self Instance) GetTransitionList() []int32

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

func (Instance) GetTransitionToTime

func (self Instance) GetTransitionToTime(from_clip int, to_clip int) gdclass.AudioStreamInteractiveTransitionToTime

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

func (Instance) HasTransition

func (self Instance) HasTransition(from_clip int, to_clip int) bool

Return true if a given transition exists (was added via [method add_transition]).

func (Instance) InitialClip

func (self Instance) InitialClip() int

func (Instance) IsTransitionHoldingPrevious

func (self Instance) IsTransitionHoldingPrevious(from_clip int, to_clip int) bool

Return whether a transition uses the [i]hold previous[/i] functionality (see [method add_transition]).

func (Instance) IsTransitionUsingFillerClip

func (self Instance) IsTransitionUsingFillerClip(from_clip int, to_clip int) bool

Return whether a transition uses the [i]filler clip[/i] functionality (see [method add_transition]).

func (Instance) SetClipAutoAdvance

func (self Instance) SetClipAutoAdvance(clip_index int, mode gdclass.AudioStreamInteractiveAutoAdvanceMode)

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

func (Instance) SetClipAutoAdvanceNextClip

func (self Instance) SetClipAutoAdvanceNextClip(clip_index int, auto_advance_next_clip int)

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.

func (Instance) SetClipCount

func (self Instance) SetClipCount(value int)

func (Instance) SetClipName

func (self Instance) SetClipName(clip_index int, name string)

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

func (Instance) SetClipStream

func (self Instance) SetClipStream(clip_index int, stream [1]gdclass.AudioStream)

Set the [AudioStream] associated with the current clip.

func (Instance) SetInitialClip

func (self Instance) SetInitialClip(value int)

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type TransitionFromTime

type TransitionFromTime = gdclass.AudioStreamInteractiveTransitionFromTime //gd:AudioStreamInteractive.TransitionFromTime

const (
	/*Start transition as soon as possible, don't wait for any specific time position.*/
	TransitionFromTimeImmediate TransitionFromTime = 0
	/*Transition when the clip playback position reaches the next beat.*/
	TransitionFromTimeNextBeat TransitionFromTime = 1
	/*Transition when the clip playback position reaches the next bar.*/
	TransitionFromTimeNextBar TransitionFromTime = 2
	/*Transition when the current clip finished playing.*/
	TransitionFromTimeEnd TransitionFromTime = 3
)

type TransitionToTime

type TransitionToTime = gdclass.AudioStreamInteractiveTransitionToTime //gd:AudioStreamInteractive.TransitionToTime

const (
	/*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.*/
	TransitionToTimeSamePosition TransitionToTime = 0
	/*Transition to the start of the destination clip.*/
	TransitionToTimeStart TransitionToTime = 1
)