ResourceImporterOggVorbis

继承： ResourceImporter < RefCounted < Object

导入 Ogg Vorbis 音频文件进行播放。

描述

Ogg Vorbis 是一种有损音频格式，在给定比特率下，其音频质量优于 ResourceImporterMP3 。

在大多数情况下，建议使用 Ogg Vorbis 而非 MP3。然而，如果您使用的音频源为 MP3 格式且没有更高品质的源可供选择，那么建议直接使用 MP3 文件，以避免双重有损压缩。

Ogg Vorbis 在解码时所需的 CPU 资源比 ResourceImporterWAV 更多。如果您需要同时播放大量声音，建议使用 WAV 格式来存储这些声音，尤其是针对低端设备时更是如此。 .. rst-class:: classref-introduction-group

属性

int	bar_beats	4
int	beat_count	0
float	bpm	0
bool	loop	false
float	loop_offset	0

方法

AudioStreamOggVorbis	load_from_buffer(stream_data: PackedByteArray) static
AudioStreamOggVorbis	load_from_file(path: String) static

---

属性说明

int bar_beats = 4 🔗

音频轨道中单个节拍内的音符数量。此参数仅适用于希望利用互动音乐功能的音乐作品，而不适用于音效。

在 Advanced Import Settings 对话框中提供了更便捷的 bar_beats 编辑器，它能让您在不重新导入音频的情况下预览您的更改。

---

int beat_count = 0 🔗

音频轨道的节拍计数。此参数仅适用于希望利用互动音乐功能的音乐作品，而不适用于音效。

在 Advanced Import Settings 对话框中提供了更便捷的 bar_beats 编辑器，它能让您在不重新导入音频的情况下预览您的更改。

---

float bpm = 0 🔗

音频轨道的每分钟节拍数。这应与用于创作该轨道的节拍每分钟数（BPM）保持一致。此设置仅适用于希望利用互动音乐功能的音乐，而不适用于音效。

在 Advanced Import Settings 对话框中提供了更便捷的 bar_beats 编辑器，它能让您在不重新导入音频的情况下预览您的更改。

---

bool loop = false 🔗

如果启用此功能，播放结束后（即到达音频的结尾时），音频将会从开头开始播放。

注意: 在 AudioStreamPlayer 中，当循环音频播放到文件末尾时，不会发出 AudioStreamPlayer.finished 信号，因为音频会无限期地持续播放。

---

float loop_offset = 0 🔗

确定在音频播放至结尾后，音频从何处开始循环。此功能可用于仅循环音频文件的一部分，这对于某些环境音效或音乐来说非常有用。该值是以音频开始位置为基准的秒数来确定的。值为 0.0 时，将循环整个音频文件。

只有在 loop 属性设置为 true 时才会生效。

在 Advanced Import Settings 对话框中提供了更便捷的 bar_beats 编辑器，它能让您在不重新导入音频的情况下预览您的更改。

---

方法说明

AudioStreamOggVorbis load_from_buffer(stream_data: PackedByteArray) static 🔗

已弃用： 请改用 AudioStreamOggVorbis.load_from_buffer()。

从给定缓冲区新建 AudioStreamOggVorbis 实例。缓冲区中必须包含 Ogg Vorbis 数据。

---

AudioStreamOggVorbis load_from_file(path: String) static 🔗

已弃用： 请改用 AudioStreamOggVorbis.load_from_file()。

从给定的文件路径新建 AudioStreamOggVorbis 实例。文件必须为 Ogg Vorbis 格式。