Table of Contents

Class ResourceImporterOggVorbis

Imports an Ogg Vorbis audio file for playback.

Inheritance
ResourceImporterOggVorbis

Remarks

Ogg Vorbis is a lossy audio format, with better audio quality compared to ResourceImporterMP3 at a given bitrate.

In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using an MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression.

Ogg Vorbis requires more CPU to decode than ResourceImporterWAV. If you need to play a lot of simultaneous sounds, it's recommended to use WAV for those sounds instead, especially if targeting low-end devices.

See Also

Importing audio samples

Properties

bar_beats

The number of bars within a single beat in the audio track. This is only relevant for music that wishes to make use of interactive music functionality, not sound effects.

A more convenient editor for bar_beats is provided in the Advanced Import Settings dialog, as it lets you preview your changes without having to reimport the audio.

var bar_beats : int = 4

Property Value

int

beat_count

The beat count of the audio track. This is only relevant for music that wishes to make use of interactive music functionality, not sound effects.

A more convenient editor for beat_count is provided in the Advanced Import Settings dialog, as it lets you preview your changes without having to reimport the audio.

var beat_count : int = 0

Property Value

int

bpm

The beats per minute of the audio track. This should match the BPM measure that was used to compose the track. This is only relevant for music that wishes to make use of interactive music functionality, not sound effects.

A more convenient editor for bpm is provided in the Advanced Import Settings dialog, as it lets you preview your changes without having to reimport the audio.

var bpm : float = 0

Property Value

float

loop

If enabled, the audio will begin playing at the beginning after playback ends by reaching the end of the audio.

Note: In AudioStreamPlayer, the finished signal won't be emitted for looping audio when it reaches the end of the audio file, as the audio will keep playing indefinitely.

var loop : bool = false

Property Value

bool

loop_offset

Determines where audio will start to loop after playback reaches the end of the audio. This can be used to only loop a part of the audio file, which is useful for some ambient sounds or music. The value is determined in seconds relative to the beginning of the audio. A value of 0.0 will loop the entire audio file.

Only has an effect if loop is true.

A more convenient editor for loop_offset is provided in the Advanced Import Settings dialog, as it lets you preview your changes without having to reimport the audio.

var loop_offset : float = 0

Property Value

float

Methods

load_from_buffer(PackedByteArray)

Qualifiers: static

Creates a new AudioStreamOggVorbis instance from the given buffer. The buffer must contain Ogg Vorbis data.

AudioStreamOggVorbis load_from_buffer(PackedByteArray stream_data)

Parameters

stream_data PackedByteArray

load_from_file(String)

Qualifiers: static

Creates a new AudioStreamOggVorbis instance from the given file path. The file must be in Ogg Vorbis format.

AudioStreamOggVorbis load_from_file(String path)

Parameters

path String