AudioStreamPlayer¶
继承¶
Node
简要描述¶
非定位播放音频。
描述¶
非定位播放音频流。
成员¶
类型 | 属性名 | 默认值 |
---|---|---|
bool | autoplay | false |
String | bus | "Master" |
int | mix_target | 0 |
float | pitch_scale | 1.0 |
bool | playing | false |
AudioStream | stream | |
bool | stream_paused | false |
float | volume_db | 0.0 |
方法¶
返回值类型 | 方法名称 |
---|---|
float | get_playback_position() |
AudioStreamPlayback | get_stream_playback() |
void | play(from_position: float = 0.0) |
void | seek(to_position: float) |
void | stop() |
信号¶
- finished
音频停止播放时发出。
枚举¶
enum MixTarget: - MIX_TARGET_STEREO = 0
音频将仅在第一个频道上播放。
- MIX_TARGET_SURROUND = 1
音频将在所有环绕声声道上播放。
- MIX_TARGET_CENTER = 2
音频将在第二个通道(通常是中心)上播放。
常量¶
成员说明¶
- bool autoplay
Default | false |
---|---|
setter | set_autoplay(value) |
getter | is_autoplay_enabled |
- String bus
Default | "Master" |
---|---|
setter | set_bus(value) |
getter | get_bus |
- int mix_target
Default | 0 |
---|---|
setter | set_mix_target(value) |
getter | get_mix_target |
- float pitch_scale
Default | 1.0 |
---|---|
setter | set_pitch_scale(value) |
getter | get_pitch_scale |
- bool playing
Default | false |
---|---|
setter | _set_playing(value) |
getter | is_playing |
- AudioStream stream
setter | set_stream(value) |
---|---|
getter | get_stream |
- bool stream_paused
Default | false |
---|---|
setter | set_stream_paused(value) |
getter | get_stream_paused |
- float volume_db
Default | 0.0 |
---|---|
setter | set_volume_db(value) |
getter | get_volume_db |
方法说明¶
- get_playback_position get_playback_position()
以秒为单位返回AudioStream中的位置。
- get_stream_playback get_stream_playback()
返回与此AudioStreamPlayer关联的AudioStreamPlayback对象。
- play play(from_position: float = 0.0)
以秒为单位,播放给定from_position
中的音频。
- seek seek(to_position: float)
设置播放音频的位置(以秒为单位)。
- stop stop()
停止音频。