Up to date
This page is up to date for Godot 4.1
.
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¶
is_stream_playing ( int stream ) const |
|
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 ( int stream ) const
Return true whether the stream associated with an integer ID is still playing. Check play_stream for information on when this ID becomes invalid.
int play_stream ( AudioStream stream, float from_offset=0, float volume_db=0, float pitch_scale=1.0 )
Play an AudioStream at a given offset, volume and pitch scale. 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.
void set_stream_pitch_scale ( int stream, float pitch_scale )
Change the stream pitch scale. The stream
argument is an integer ID returned by play_stream.
void set_stream_volume ( int stream, float volume_db )
Change the stream volume (in db). The stream
argument is an integer ID returned by play_stream.
void stop_stream ( int stream )
Stop a stream. The stream
argument is an integer ID returned by play_stream, which becomes invalid after calling this function.