Table of Contents

Class AudioStreamOggVorbis

A class representing an Ogg Vorbis audio stream.

Inheritance
AudioStreamOggVorbis

Remarks

The AudioStreamOggVorbis class is a specialized AudioStream for handling Ogg Vorbis file formats. It offers functionality for loading and playing back Ogg Vorbis files, as well as managing looping and other playback properties. This class is part of the audio stream system, which also supports WAV files through the AudioStreamWAV class.

See Also

Runtime file loading and saving

Properties

bar_beats 

var bar_beats : int = 4

Property Value

int

Remarks

  • void set_bar_beats(int value)
  • int get_bar_beats

beat_count 

var beat_count : int = 0

Property Value

int

Remarks

  • void set_beat_count(int value)
  • int get_beat_count

bpm 

var bpm : float = 0.0

Property Value

float

Remarks

loop

If true, the audio will play again from the specified loop_offset once it is done playing. Useful for ambient sounds and background music.

var loop : bool = false

Property Value

bool

Remarks

  • void set_loop(bool value)
  • bool has_loop

loop_offset

Time in seconds at which the stream starts after being looped.

var loop_offset : float = 0.0

Property Value

float

Remarks

  • void set_loop_offset(float value)
  • float get_loop_offset

packet_sequence

Contains the raw Ogg data for this stream.

var packet_sequence : OggPacketSequence

Property Value

OggPacketSequence

Remarks

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