AudioStreamGeneratorPlayback

Documentation

Overview

Package AudioStreamGeneratorPlayback provides methods for working with AudioStreamGeneratorPlayback object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsAudioStreamGeneratorPlayback() Instance
  • func (self Instance) AsAudioStreamPlayback() AudioStreamPlayback.Instance
  • func (self Instance) AsAudioStreamPlaybackResampled() AudioStreamPlaybackResampled.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) CanPushBuffer(amount int) bool
  • func (self Instance) ClearBuffer()
  • func (self Instance) GetFramesAvailable() int
  • func (self Instance) GetSkips() int
  • func (self Instance) PushBuffer(frames []Vector2.XY) bool
  • func (self Instance) PushFrame(frame_ Vector2.XY) bool
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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

type Instance

type Instance [1]gdclass.AudioStreamGeneratorPlayback

This class is meant to be used with [AudioStreamGenerator] to play back the generated audio in real-time.

var Nil Instance

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

func New

func New() Instance

func (Instance) AsAudioStreamGeneratorPlayback

func (self Instance) AsAudioStreamGeneratorPlayback() Instance

func (Instance) AsAudioStreamPlayback

func (self Instance) AsAudioStreamPlayback() AudioStreamPlayback.Instance

func (Instance) AsAudioStreamPlaybackResampled

func (self Instance) AsAudioStreamPlaybackResampled() AudioStreamPlaybackResampled.Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) CanPushBuffer

func (self Instance) CanPushBuffer(amount int) bool

Returns [code]true[/code] if a buffer of the size [param amount] can be pushed to the audio sample data buffer without overflowing it, [code]false[/code] otherwise.

func (Instance) ClearBuffer

func (self Instance) ClearBuffer()

Clears the audio sample data buffer.

func (Instance) GetFramesAvailable

func (self Instance) GetFramesAvailable() int

Returns the number of frames that can be pushed to the audio sample data buffer without overflowing it. If the result is [code]0[/code], the buffer is full.

func (Instance) GetSkips

func (self Instance) GetSkips() int

Returns the number of times the playback skipped due to a buffer underrun in the audio sample data. This value is reset at the start of the playback.

func (Instance) PushBuffer

func (self Instance) PushBuffer(frames []Vector2.XY) bool

Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDExtension, but [method push_buffer] may be [i]less[/i] efficient in GDScript.

func (Instance) PushFrame

func (self Instance) PushFrame(frame_ Vector2.XY) bool

Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDExtension, but [method push_frame] may be [i]more[/i] efficient in GDScript.

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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