Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
AudioStream
继承： Resource < RefCounted < Object
派生： AudioStreamGenerator, AudioStreamInteractive, AudioStreamMicrophone, AudioStreamMP3, AudioStreamOggVorbis, AudioStreamPlaylist, AudioStreamPolyphonic, AudioStreamRandomizer, AudioStreamSynchronized, AudioStreamWAV
音频流的基类。
描述
音频流的基类。音频流用于播放音效和音乐，支持 WAV（通过 AudioStreamWAV）和 Ogg（通过 AudioStreamOggVorbis）文件格式。
教程
方法
_get_bar_beats() virtual const |
|
_get_beat_count() virtual const |
|
_get_bpm() virtual const |
|
_get_length() virtual const |
|
_get_parameter_list() virtual const |
|
_get_stream_name() virtual const |
|
_has_loop() virtual const |
|
_instantiate_playback() virtual const |
|
_is_monophonic() virtual const |
|
can_be_sampled() const |
|
generate_sample() const |
|
get_length() const |
|
is_meta_stream() const |
|
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() 的返回值。应该返回一个在播放流（例如通过 AudioStreamPlayer）时创建的新的 AudioStreamPlayback。
bool _is_monophonic() virtual const 🔗
覆盖该方法以自定义 is_monophonic() 的返回值。如果该音频流仅支持一个通道，则应返回 true。
实验性： 未来版本中可能会修改或移除该方法。
返回当前 AudioStream 是否可以用作样本。仅可对静态流进行采样。
AudioSample generate_sample() const 🔗
实验性： 未来版本中可能会修改或移除该方法。
根据当前流生成 AudioSample。
返回音频流的长度，单位为秒。
AudioStreamPlayback instantiate_playback() 🔗
返回一个新创建的 AudioStreamPlayback，用于播放该音频流。当想要扩展 _instantiate_playback()，但从一个内部持有的 AudioStream 子资源调用 instantiate_playback() 时很有用。在 AudioStreamRandomPitch::instantiate_playback 的源代码中可以找到这方面的示例。
如果该流是其他流的集合，则返回 true，否则返回 false。
如果该音频流仅支持一个通道（单声道），则返回 true；如果音频流支持两个或多个通道（复调），则返回 false。