跳转至

AudioStreamPlayer2D

继承

Node2D

简要描述

播放2D音频。

描述

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

成员

类型 属性名 默认值
int area_mask 1
float attenuation 1.0
bool autoplay false
String bus "Master"
float max_distance 2000.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

音频停止播放时发出。

常量

成员说明

  • int area_mask
Default 1
setter set_area_mask(value)
getter get_area_mask
  • float attenuation
Default 1.0
setter set_attenuation(value)
getter get_attenuation
  • bool autoplay
Default false
setter set_autoplay(value)
getter is_autoplay_enabled
  • String bus
Default "Master"
setter set_bus(value)
getter get_bus
  • float max_distance
Default 2000.0
setter set_max_distance(value)
getter get_max_distance
  • 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()

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

  • play play(from_position: float = 0.0)

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

  • seek seek(to_position: float)

设置播放音频的位置（以秒为单位）。

  • stop stop()

停止音频。