AudioStreamPlayback

Documentation

Overview

Package AudioStreamPlayback provides methods for working with AudioStreamPlayback object instances.

Index

• type Advanced
• type Any
• type AudioFrame
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioStreamPlayback() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) GetSamplePlayback() [1]gdclass.AudioSamplePlayback
  • func (self Instance) SetSamplePlayback(playback_sample [1]gdclass.AudioSamplePlayback)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

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
	AsAudioStreamPlayback() Instance
}

type AudioFrame

type AudioFrame = gd.AudioFrame

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.AudioStreamPlayback

Can play, loop, pause a scroll through audio. See [AudioStream] and [AudioStreamOggVorbis] for usage.

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=AudioStreamPlayback)

var Nil Instance

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

func New

func New() Instance

func (Instance) AsAudioStreamPlayback

func (self Instance) AsAudioStreamPlayback() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) GetSamplePlayback

func (self Instance) GetSamplePlayback() [1]gdclass.AudioSamplePlayback

Returns the [AudioSamplePlayback] associated with this [AudioStreamPlayback] for playing back the audio sample of this stream.

func (Instance) SetSamplePlayback

func (self Instance) SetSamplePlayback(playback_sample [1]gdclass.AudioSamplePlayback)

Associates [AudioSamplePlayback] to this [AudioStreamPlayback] for playing back the audio sample of this stream.

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

type Interface

type Interface interface {
	//Override this method to customize what happens when the playback starts at the given position, such as by calling [method AudioStreamPlayer.play].
	Start(from_pos Float.X)
	//Override this method to customize what happens when the playback is stopped, such as by calling [method AudioStreamPlayer.stop].
	Stop()
	//Overridable method. Should return [code]true[/code] if this playback is active and playing its audio stream.
	IsPlaying() bool
	//Overridable method. Should return how many times this audio stream has looped. Most built-in playbacks always return [code]0[/code].
	GetLoopCount() int
	//Overridable method. Should return the current progress along the audio stream, in seconds.
	GetPlaybackPosition() Float.X
	//Override this method to customize what happens when seeking this audio stream at the given [param position], such as by calling [method AudioStreamPlayer.seek].
	Seek(position Float.X)
	//Override this method to customize how the audio stream is mixed. This method is called even if the playback is not active.
	//[b]Note:[/b] It is not useful to override this method in GDScript or C#. Only GDExtension can take advantage of it.
	Mix(buffer *AudioFrame, rate_scale Float.X, frames int) int
	//Overridable method. Called whenever the audio stream is mixed if the playback is active and [method AudioServer.set_enable_tagging_used_audio_streams] has been set to [code]true[/code]. Editor plugins may use this method to "tag" the current position along the audio stream and display it in a preview.
	TagUsedStreams()
	//Set the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
	SetParameter(name string, value any)
	//Return the current value of a playback parameter by name (see [method AudioStream._get_parameter_list]).
	GetParameter(name string) any
}