Index · Object → RefCounted → AudioStreamPlayback → AudioStreamPlaybackResampled → AudioStreamGeneratorPlayback

AudioStreamGeneratorPlayback

Plays back audio generated using AudioStreamGenerator.

Class Description

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

Methods

func can_push_buffer(amount: int) -> bool

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

func clear_buffer() -> void

Clears the audio sample data buffer.

func get_frames_available() -> int

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

func get_skips() -> 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 push_buffer(frames: PackedVector2Array) -> bool

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

func push_frame(frame: Vector2) -> bool

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

Inherited from AudioStreamPlaybackResampled (3)
func _mix_resampled(dst_buffer: AudioFrame*, frame_count: int) -> int
func begin_resample() -> void
Inherited from AudioStreamPlayback (19)
func _is_playing() -> bool
func _mix(buffer: AudioFrame*, rate_scale: float, frames: int) -> int
func _seek(position: float) -> void
func _set_parameter(name: StringName, value: Variant) -> void
func _start(from_pos: float) -> void
func _stop() -> void
func _tag_used_streams() -> void
func is_playing() -> bool
func mix_audio(rate_scale: float, frames: int) -> PackedVector2Array
func seek(time: float = 0.0) -> void
func set_sample_playback(playback_sample: AudioSamplePlayback) -> void
func start(from_pos: float = 0.0) -> void
func stop() -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)