AudioStream

继承: Resource < RefCounted < Object

派生: AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV

音频流的基类。

描述

音频流的基类。音频流用于音效和音乐播放,支持WAV(通过AudioStreamWAV)和Ogg(通过AudioStreamOggVorbis)文件格式。

方法

int

_get_bar_beats() virtual const

int

_get_beat_count() virtual const

float

_get_bpm() virtual const

float

_get_length() virtual const

Array[Dictionary]

_get_parameter_list() virtual const

String

_get_stream_name() virtual const

bool

_has_loop() virtual const

AudioStreamPlayback

_instantiate_playback() virtual const

bool

_is_monophonic() virtual const

bool

can_be_sampled() const

AudioSample

generate_sample() const

float

get_length() const

AudioStreamPlayback

instantiate_playback()

bool

is_meta_stream() const

bool

is_monophonic() const


信号

parameter_list_changed() 🔗

当参数列表发生变化时发出通知的信号。


方法说明

int _get_bar_beats() virtual const 🔗

重写此方法以返回此流的小节节拍。


int _get_beat_count() virtual const 🔗

可覆盖的方法。应返回此音频流的总节拍数。由引擎用于确定每个节拍的位置。

理想情况下,返回值应该基于流的采样率(例如AudioStreamWAV.mix_rate)。


float _get_bpm() virtual const 🔗

可覆盖的方法。应返回此音频流的节奏,以每分钟节拍(BPM)为单位。由发动机用于确定每个节拍的位置。

理想情况下,返回值应该基于流的采样率(例如AudioStreamWAV.mix_rate)。


float _get_length() virtual const 🔗

重写此方法以自定义get_length()的返回值。应返回此音频流的长度,以秒为单位。


Array[Dictionary] _get_parameter_list() virtual const 🔗

返回此流的可控参数。此数组包含具有属性信息描述格式的字典(参见Object.get_property_list())。此外,此参数的默认值必须添加到“default_value”字段中的每个字典中。


String _get_stream_name() virtual const 🔗

重写此方法以自定义分配给此音频流的名称。未被引擎使用。


bool _has_loop() virtual const 🔗

如果此流有循环,则覆盖此方法以返回true


AudioStreamPlayback _instantiate_playback() virtual const 🔗

重写此方法以自定义instantiate_playback()的返回值。应返回播放流时创建的新AudioStreamPlayback(例如由AudioStreamPlayer)。


bool _is_monophonic() virtual const 🔗

重写此方法以自定义is_monophonic()的返回值。如果此音频流仅支持一个通道,则应返回true


bool can_be_sampled() const 🔗

实验性: 未来版本中可能会修改或移除该方法。

返回当前AudioStream是否可以用作样本。只能采样静态流。


AudioSample generate_sample() const 🔗

实验性: 未来版本中可能会修改或移除该方法。

根据当前流生成AudioSample


float get_length() const 🔗

以秒为单位返回音频流的长度。


AudioStreamPlayback instantiate_playback() 🔗

返回新创建的用于播放此音频流的AudioStreamPlayback。当您想要扩展_instantiate_playback()但从内部保存的AudioStream子资源调用instantiate_playback()时很有用。可以在AudioStreamRandomPitch::的源代码中找到这方面的示例。


bool is_meta_stream() const 🔗

如果流是其他流的集合,则返回true,否则返回false


bool is_monophonic() const 🔗

如果此音频流仅支持一个通道(单声道),则返回true,如果音频流支持两个或多个通道(复调),则返回false