AudioStreamPlayer2D¶
Inherits: Node2D < CanvasItem < Node < Object
在 2D 空间中播放位置声音。
描述¶
播放音频,随着与屏幕中心的距离而减弱。
参阅AudioStreamPlayer来播放非位置性的声音。
注意: 隐藏一个AudioStreamPlayer2D
节点并不能禁用其音频输出。要暂时禁用AudioStreamPlayer2D
的音频输出,请将volume_db设置为一个非常低的值,如-100
(人的听觉听不到)。
教程¶
属性¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
方法¶
void |
|
void |
|
void |
stop ( ) |
信号¶
finished ( )
当音频停止播放时发出。
属性说明¶
int area_mask
Default |
|
Setter |
set_area_mask(value) |
Getter |
get_area_mask() |
这个声音的播放区域。
float attenuation
Default |
|
Setter |
set_attenuation(value) |
Getter |
get_attenuation() |
以此为指数,将声音在距离上进行衰减。
bool autoplay
Default |
|
Setter |
set_autoplay(value) |
Getter |
is_autoplay_enabled() |
如果true
,则在添加到场景树时播放音频。
String bus
Default |
|
Setter |
set_bus(value) |
Getter |
get_bus() |
播放此音频的总线。
float max_distance
Default |
|
Setter |
set_max_distance(value) |
Getter |
get_max_distance() |
音频仍可听到的最大距离。
float pitch_scale
Default |
|
Setter |
set_pitch_scale(value) |
Getter |
get_pitch_scale() |
音频的音高和节奏,作为音频样本的采样率的倍数。
bool playing
Default |
|
Getter |
is_playing() |
如果true
,则播放音频。
AudioStream stream
Setter |
set_stream(value) |
Getter |
get_stream() |
要播放的AudioStream对象。
bool stream_paused
Default |
|
Setter |
set_stream_paused(value) |
Getter |
get_stream_paused() |
如果 true
,则暂停播放。您可以通过将 stream_paused
设置为 false
来恢复播放。
float volume_db
Default |
|
Setter |
set_volume_db(value) |
Getter |
get_volume_db() |
基础音量,无衰减。
方法说明¶
float get_playback_position ( )
返回AudioStream中的位置。
AudioStreamPlayback get_stream_playback ( )
返回与该AudioStreamPlayer2D
相关联的AudioStreamPlayback对象。
void play ( float from_position=0.0 )
从给定的位置from_position
播放音频,以秒为单位。
void seek ( float to_position )
设置音频的播放位置,以秒为单位。
void stop ( )
停止音频。