Index · Object → RefCounted → AudioStreamPlayback → AudioStreamPlaybackPolyphonic

AudioStreamPlaybackPolyphonic

Playback instance for AudioStreamPolyphonic.

Class Description

Playback instance for AudioStreamPolyphonic. After setting the stream property of AudioStreamPlayer, AudioStreamPlayer2D, or AudioStreamPlayer3D, the playback instance can be obtained by calling AudioStreamPlayer.get_stream_playback(), AudioStreamPlayer2D.get_stream_playback() or AudioStreamPlayer3D.get_stream_playback() methods.

Methods

func is_stream_playing(stream: int) -> bool

Returns true if the stream associated with the given integer ID is still playing. Check play_stream() for information on when this ID becomes invalid.

func play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: AudioServer.PlaybackType = 0, bus: StringName = &"Master") -> int

Play an AudioStream at a given offset, volume, pitch scale, playback type, and bus. Playback starts immediately.

The return value is a unique integer ID that is associated to this playback stream and which can be used to control it.

This ID becomes invalid when the stream ends (if it does not loop), when the AudioStreamPlaybackPolyphonic is stopped, or when stop_stream() is called.

This function returns INVALID_ID if the amount of streams currently playing equals AudioStreamPolyphonic.polyphony. If you need a higher amount of maximum polyphony, raise this value.

func set_stream_pitch_scale(stream: int, pitch_scale: float) -> void

Change the stream pitch scale. The stream argument is an integer ID returned by play_stream().

func set_stream_volume(stream: int, volume_db: float) -> void

Change the stream volume (in db). The stream argument is an integer ID returned by play_stream().

func stop_stream(stream: int) -> void

Stop a stream. The stream argument is an integer ID returned by play_stream(), which becomes invalid after calling this function.

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)

Enums & Constants

const INVALID_ID = -1

Returned by play_stream() in case it could not allocate a stream for playback.