Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

AudioStreamPlaybackPolyphonic

Inherits: AudioStreamPlayback < RefCounted < Object

Playback instance for AudioStreamPolyphonic.

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

bool

is_stream_playing ( int stream ) const

int

play_stream ( AudioStream stream, float from_offset=0, float volume_db=0, float pitch_scale=1.0 )

void

set_stream_pitch_scale ( int stream, float pitch_scale )

void

set_stream_volume ( int stream, float volume_db )

void

stop_stream ( int stream )


Constants

INVALID_ID = -1

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


Method Descriptions

bool is_stream_playing (