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.

AudioStreamOggVorbis

Eredita: AudioStream < Resource < RefCounted < Object

Una classe che rappresenta un flusso audio in Ogg Vorbis.

Descrizione

La classe AudioStreamOggVorbis è un AudioStream specializzato nella gestione dei formati di file Ogg Vorbis. Offre funzionalità per caricare e riprodurre file Ogg Vorbis, oltre a gestire la ripetizione e altre proprietà di riproduzione. Ulteriori informazioni sono disponibili in ResourceImporterOggVorbis.

Questa classe fa parte del sistema di flusso audio, che supporta anche i file WAV tramite la classe AudioStreamWAV e i file MP3 tramite la classe AudioStreamMP3.

Tutorial

Proprietà

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

{}

Metodi

AudioStreamOggVorbis

load_from_buffer(stream_data: PackedByteArray) static

AudioStreamOggVorbis

load_from_file(path: String) static


Descrizioni delle proprietà

int bar_beats = 4 🔗

  • void set_bar_beats(value: int)

  • int get_bar_beats()

Il numero di battiti all'interno di una singola battuta nella traccia audio.


int beat_count = 0 🔗

  • void set_beat_count(value: int)

  • int get_beat_count()

La durata della traccia audio, in battiti. La durata effettiva del file audio potrebbe essere più lunga di quanto indicato da questa proprietà. Definisce la fine dell'audio per la ripetizione, per AudioStreamPlaylist e per AudioStreamInteractive.


float bpm = 0.0 🔗

Il tempo della traccia audio, misurato in battiti al minuto.


bool loop = false 🔗

  • void set_loop(value: bool)

  • bool has_loop()

Se true, il flusso verrà riprodotto di nuovo a partire dal loop_offset specificato una volta raggiunta la fine della traccia audio, oppure una volta raggiunta la fine dell'ultimo battito in base al numero specificato in beat_count. Utile per suoni ambientali e musica di sottofondo.


float loop_offset = 0.0 🔗

  • void set_loop_offset(value: float)

  • float get_loop_offset()

Tempo in secondi in cui il flusso comincia dopo essere stato ripetuto.


OggPacketSequence packet_sequence 🔗

Contiene il dati Ogg grezzi per questo flusso.


Dictionary tags = {} 🔗

Contiene tag definiti dall'utente se presenti nei dati Ogg Vorbis.

I tag comunemente utilizzati includono title, artist, album, tracknumber e date (date non ha un formato di data standard).

Nota: Nessun tag è garantito a essere presente in ogni file, quindi assicurati di tenere conto di chiavi che non esistono sempre.


Descrizioni dei metodi

AudioStreamOggVorbis load_from_buffer(stream_data: PackedByteArray) static 🔗

Crea una nuova istanza AudioStreamOggVorbis dal buffer fornito. Il buffer deve contenere i dati in Ogg Vorbis.


AudioStreamOggVorbis load_from_file(path: String) static 🔗

Crea una nuova istanza AudioStreamOggVorbis dal percorso di file fornito. Il file deve essere in formato Ogg Vorbis.