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...

AudioStreamOggVorbis

Hérite de : AudioStream < Resource < RefCounted < Object

Une classe représentant un flux audio Ogg Vorbis.

Description

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. More info can be found in ResourceImporterOggVorbis.

This class is part of the audio stream system, which also supports WAV files through the AudioStreamWAV class, and MP3 files through the AudioStreamMP3 class.

Tutoriels

Propriétés

int

bar_beats

4

int

beat_count

0

float

bpm

0.0

bool

loop

false

float

loop_offset

0.0

OggPacketSequence

packet_sequence

Dictionary

tags

{}

Méthodes

AudioStreamOggVorbis

load_from_buffer(stream_data: PackedByteArray) static

AudioStreamOggVorbis

load_from_file(path: String) static

Descriptions des propriétés

int bar_beats = 4 🔗

  • void set_bar_beats(value: int)

  • int get_bar_beats()

The number of beats within a single bar in the audio track.

int beat_count = 0 🔗

  • void set_beat_count(value: int)

  • int get_beat_count()

The length of the audio track, in beats. The actual duration of the audio file might be longer than what is indicated by this property. It defines the end of the audio for looping, AudioStreamPlaylist, and AudioStreamInteractive.

float bpm = 0.0 🔗

The tempo of the audio track, measured in beats per minute.

bool loop = false 🔗

  • void set_loop(value: bool)

  • bool has_loop()

If true, the stream will play again from the specified loop_offset once it reaches the end of the audio track, or once it reaches the end of the last beat according to the amount specified in beat_count. Useful for ambient sounds and background music.

float loop_offset = 0.0 🔗

  • void set_loop_offset(value: float)

  • float get_loop_offset()

Le temps en secondes où le flux commence après avoir bouclé.

OggPacketSequence packet_sequence 🔗

Contient les données Ogg brutes pour ce flux.

Dictionary tags = {} 🔗

Contient des tags définis par l'utilisateur si trouvés dans les données Ogg Vorbis.

Les tags couramment utilisés incluent title, artist, album, tracknumber, et date (date n'a pas un format de data standard).

Note : Aucun tag n'est * garanti* d'être présent dans chaque fichier, alors assurez-vous de tenir compte des clés qui n'existent pas toujours.

Descriptions des méthodes

AudioStreamOggVorbis load_from_buffer(stream_data: PackedByteArray) static 🔗

Crée une nouvelle instance AudioStreamOggVorbis depuis le tampon donné. Le tampon doit contenir des données Ogg Vorbis.

AudioStreamOggVorbis load_from_file(path: String) static 🔗

Crée une nouvelle instance AudioStreamOggVorbis depuis le chemin de fichier donné. Le fichier doit être au format Ogg Vorbis.