AudioStreamPlayer

AudioStreamPlayer

Inherits: Node < Object

非定位地播放音频。

描述

以非位置方式支持播放音频流。

要在位置上播放音频，请使用AudioStreamPlayer2D或AudioStreamPlayer3D而不是AudioStreamPlayer。

教程

属性

bool	autoplay	`false`
String	bus	`“Master”`
MixTarget	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 ( float from_position=0.0 )
void	seek ( float to_position )
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()

如果true，则在添加到场景树时播放音频。

String bus

Default	`“Master”`
Setter	set_bus(value)
Getter	get_bus()

播放此音频的总线。

MixTarget mix_target

Default	`0`
Setter	set_mix_target(value)
Getter	get_mix_target()

如果音频配置有两个以上的扬声器，则设置目标通道。请参阅MixTarget常量。

float pitch_scale

Default	`1.0`
Setter	set_pitch_scale(value)
Getter	get_pitch_scale()

音频的音高和节奏，作为音频样本的采样率的倍数。

bool playing

Default	`false`
Getter	is_playing()

如果true，则播放音频。

AudioStream stream

Setter	set_stream(value)
Getter	get_stream()

要播放的AudioStream对象。

bool stream_paused

Default	`false`
Setter	set_stream_paused(value)
Getter	get_stream_paused()

如果 true，则暂停播放。您可以通过将 stream_paused 设置为 false 来恢复播放。

float volume_db

Default	`0.0`
Setter	set_volume_db(value)
Getter	get_volume_db()

音量，单位为dB。

方法说明

float get_playback_position ( )

返回AudioStream中的位置，单位为秒。

AudioStreamPlayback get_stream_playback ( )

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

void play ( float from_position=0.0 )

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

void seek ( float to_position )

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

void stop ( )

停止音频。