跳到主要内容

AudioStreamPlayer2D

继承

Node2D

简要描述

播放2D音频。

描述

播放随着距屏幕中心距离而衰减的音频。

成员

类型属性名默认值
intarea_mask1
floatattenuation1.0
boolautoplayfalse
Stringbus"Master"
floatmax_distance2000.0
floatpitch_scale1.0
boolplayingfalse
AudioStreamstream
boolstream_pausedfalse
floatvolume_db0.0

方法

返回值类型方法名称
floatget_playback_position()
AudioStreamPlaybackget_stream_playback()
voidplay(from_position: float = 0.0)
voidseek(to_position: float)
voidstop()

信号

  • **finished**

音频停止播放时发出。


常量

成员说明

  • int area_mask
Default1
setterset_area_mask(value)
getterget_area_mask
  • float attenuation
Default1.0
setterset_attenuation(value)
getterget_attenuation
  • bool autoplay
Defaultfalse
setterset_autoplay(value)
getteris_autoplay_enabled
  • String bus
Default"Master"
setterset_bus(value)
getterget_bus
  • float max_distance
Default2000.0
setterset_max_distance(value)
getterget_max_distance
  • float pitch_scale
Default1.0
setterset_pitch_scale(value)
getterget_pitch_scale
  • bool playing
Defaultfalse
setter_set_playing(value)
getteris_playing
  • AudioStream stream
setterset_stream(value)
getterget_stream
  • bool stream_paused
Defaultfalse
setterset_stream_paused(value)
getterget_stream_paused
  • float volume_db
Default0.0
setterset_volume_db(value)
getterget_volume_db

方法说明

  • get_playback_position get_playback_position()

返回AudioStream中的位置。


  • get_stream_playback get_stream_playback()

返回与此AudioStreamPlayer2D关联的AudioStreamPlayback对象。


  • play play(from_position: float = 0.0)

以秒为单位,从给定位置from_position播放音频。


  • seek seek(to_position: float)

设置播放音频的位置(以秒为单位)。


  • stop stop()

停止音频。