Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioStreamPlaybackPolyphonic

继承： AudioStreamPlayback < RefCounted < Object

AudioStreamPolyphonic 的播放实例。

描述

AudioStreamPolyphonic 的播放实例。设置 AudioStreamPlayer、AudioStreamPlayer2D 或 AudioStreamPlayer3D 的 stream 属性后，可以通过调用 AudioStreamPlayer.get_stream_playback()、AudioStreamPlayer2D.get_stream_playback() 或 AudioStreamPlayer3D.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。与 ID 何时失效相关的信息请查看 play_stream()。

---

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，在调用这个函数后失效。