AudioStreamPlaybackPolyphonic

继承: AudioStreamPlayback < RefCounted < Object

AudioStreamPolyphonic的回放实例。

描述

AudioStreamPolyphonic的回放实例。设置AudioStreamPlayerAudioPlayerstream属性后,可以通过调用AudioStreamPlayer.get_stream_playback()AudioPlayer.get_stream_playback()方法获取回放实例。

方法

bool

is_stream_playing(stream: int) const

int

play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master")

void

set_stream_pitch_scale(stream: int, pitch_scale: float)

void

set_stream_volume(stream: int, volume_db: float)

void

stop_stream(stream: int)


常量

INVALID_ID = -1 🔗

play_stream()返回,以防无法分配流进行回放。


方法说明

bool is_stream_playing(stream: int) const 🔗

如果与给定整数ID关联的流仍在播放,则返回true。检查play_stream()以获取有关此ID何时无效的信息。


int play_stream(stream: AudioStream, from_offset: float = 0, volume_db: float = 0, pitch_scale: float = 1.0, playback_type: PlaybackType = 0, bus: StringName = &"Master") 🔗

以给定的偏移量、音量、音高比例、播放类型和总线播放AudioStream。立即开始播放。

返回值是与此播放流关联的唯一整数ID,可用于控制它。

当流结束(如果不循环)、AudioStreamPlaybackPolyphonic停止或调用stop_stream()时,此ID将无效。

如果当前播放的流数量等于AudioStreamPolyphonic.polyphony,则此函数返回INVALID_ID。如果您需要更高的最大复调量,请提高此值。


void set_stream_pitch_scale(stream: int, pitch_scale: float) 🔗

更改流间距刻度。stream参数是play_stream()返回的整数ID。


void set_stream_volume(stream: int, volume_db: float) 🔗

更改流体积(以db为单位)。stream参数是play_stream()返回的整数ID。


void stop_stream(stream: int) 🔗

停止流。stream参数是play_stream()返回的整数ID,调用此函数后无效。