AudioStreamPlayer3D

继承

Spatial

简要描述

在3D空间中播放3D声音。

描述

播放具有定向声音效果的声音效果，根据需要衰减距离，在空间中产生可听见位置的效果。

成员

类型	属性名	默认值
int	area_mask	1
float	attenuation_filter_cutoff_hz	5000.0
float	attenuation_filter_db	-24.0
int	attenuation_model	0
bool	autoplay	false
String	bus	"Master"
int	doppler_tracking	0
float	emission_angle_degrees	45.0
bool	emission_angle_enabled	false
float	emission_angle_filter_attenuation_db	-12.0
float	max_db	3.0
float	max_distance	0.0
int	out_of_range_mode	0
float	pitch_scale	1.0
bool	playing	false
AudioStream	stream
bool	stream_paused	false
float	unit_db	0.0
float	unit_size	1.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 AttenuationModel:

• **ATTENUATION_INVERSE_DISTANCE = 0**

根据距离线性降低响度。

• **ATTENUATION_INVERSE_SQUARE_DISTANCE = 1**

响度根据距离的平方衰减。

• **ATTENUATION_LOGARITHMIC = 2**

根据距离对数降低响度。

• **ATTENUATION_DISABLED = 3**

不会根据距离减弱响度。

---

enum OutOfRangeMode:

• **OUT_OF_RANGE_MIX = 0**

混入此音频，即使超出范围也是如此。

• **OUT_OF_RANGE_PAUSE = 1**

超出范围时暂停此音频。

---

enum DopplerTracking:

• **DOPPLER_TRACKING_DISABLED = 0**

禁用多普勒跟踪。

• **DOPPLER_TRACKING_IDLE_STEP = 1**

在空闲步骤中执行多普勒跟踪。

• **DOPPLER_TRACKING_PHYSICS_STEP = 2**

在物理步骤中执行多普勒跟踪。

---

常量

成员说明

• int area_mask

Default	1
setter	set_area_mask(value)
getter	get_area_mask

• float attenuation_filter_cutoff_hz

Default	5000.0
setter	set_attenuation_filter_cutoff_hz(value)
getter	get_attenuation_filter_cutoff_hz

• float attenuation_filter_db

Default	-24.0
setter	set_attenuation_filter_db(value)
getter	get_attenuation_filter_db

• int attenuation_model

Default	0
setter	set_attenuation_model(value)
getter	get_attenuation_model

• bool autoplay

Default	false
setter	set_autoplay(value)
getter	is_autoplay_enabled

• String bus

Default	"Master"
setter	set_bus(value)
getter	get_bus

• int doppler_tracking

Default	0
setter	set_doppler_tracking(value)
getter	get_doppler_tracking

• float emission_angle_degrees

Default	45.0
setter	set_emission_angle(value)
getter	get_emission_angle

• bool emission_angle_enabled

Default	false
setter	set_emission_angle_enabled(value)
getter	is_emission_angle_enabled

• float emission_angle_filter_attenuation_db

Default	-12.0
setter	set_emission_angle_filter_attenuation_db(value)
getter	get_emission_angle_filter_attenuation_db

• float max_db

Default	3.0
setter	set_max_db(value)
getter	get_max_db

• float max_distance

Default	0.0
setter	set_max_distance(value)
getter	get_max_distance

• int out_of_range_mode

Default	0
setter	set_out_of_range_mode(value)
getter	get_out_of_range_mode

• 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 unit_db

Default	0.0
setter	set_unit_db(value)
getter	get_unit_db

• float unit_size

Default	1.0
setter	set_unit_size(value)
getter	get_unit_size

方法说明

• get_playback_position get_playback_position()

返回AudioStream中的位置。

---

• get_stream_playback get_stream_playback()

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

---

• play play(from_position: float = 0.0)

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

---

• seek seek(to_position: float)

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

---

• stop stop()

停止音频。

---