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

AudioStreamPlayback

Hérite de : RefCounted < Object

Hérité par : AudioStreamPlaybackInteractive, AudioStreamPlaybackPlaylist, AudioStreamPlaybackPolyphonic, AudioStreamPlaybackResampled, AudioStreamPlaybackSynchronized

Classe méta pour la lecture audio.

Description

Peut jouer, boucler, faire pause dans l'audio. Voir AudioStream et AudioStreamOggVorbis pour l'utilisation.

Tutoriels

Méthodes

int

_get_loop_count() virtual const

Variant

_get_parameter(name: StringName) virtual const

float

_get_playback_position() virtual required const

bool

_is_playing() virtual required const

int

_mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual required

void

_seek(position: float) virtual

void

_set_parameter(name: StringName, value: Variant) virtual

void

_start(from_pos: float) virtual required

void

_stop() virtual required

void

_tag_used_streams() virtual

int

get_loop_count() const

float

get_playback_position() const

AudioSamplePlayback

get_sample_playback() const

bool

is_playing() const

PackedVector2Array

mix_audio(rate_scale: float, frames: int)

void

seek(time: float = 0.0)

void

set_sample_playback(playback_sample: AudioSamplePlayback)

void

start(from_pos: float = 0.0)

void

stop()

Descriptions des méthodes

int _get_loop_count() virtual const 🔗

Méthode surchargeable. Devrait renvoyer combien de fois ce flux audio a bouclé. La plupart des lecteurs intégrés renverront toujours 0.

Variant _get_parameter(name: StringName) virtual const 🔗

Renvoie la valeur courante d'un paramètre de lecture par son nom (voir AudioStream._get_parameter_list()).

float _get_playback_position() virtual required const 🔗

Méthode redéfinissable. Devrait renvoyer la progression actuelle du flux audio, en secondes.

bool _is_playing() virtual required const 🔗

Méthode redéfinissable. Devrait renvoyer true si la lecture est active et joue son flux audio.

int _mix(buffer: AudioFrame*, rate_scale: float, frames: int) virtual required 🔗

Redéfinissez cette méthode pour personnaliser la façon dont le flux audio est mixé. Cette méthode est appelée même si la lecture n'est pas active.

Note : Il n'est pas utile de redéfinir cette méthode en GDScript ou C#. Seul GDExtension peut en profiter.

void _seek(position: float) virtual 🔗

Redéfinissez cette méthode pour personnaliser ce qui se passe lors de la recherche de ce flux audio pour la position position donnée, comme lors de l'appel de AudioStreamPlayer.seek().

void _set_parameter(name: StringName, value: Variant) virtual 🔗

Définit la valeur actuelle d'un paramètre de lecture par nom (voir AudioStream._get_parameter_list()).

void _start(from_pos: float) virtual required 🔗

Redéfinissez cette méthode pour personnaliser ce qui se passe lorsque la lecture commence à la position donnée, comme lors de l'appel AudioStreamPlayer.play().

void _stop() virtual required 🔗

Redéfinissez cette méthode pour personnaliser ce qui se passe lorsque la lecture est arrêtée, comme lors de l'appel de AudioStreamPlayer.stop().

void _tag_used_streams() virtual 🔗

Méthode redéfinissable. Appelée chaque fois que le flux audio est mixé si la lecture est active et que AudioServer.set_enable_tagging_used_audio_streams() a été défini à true. Les plugins d'éditeur peuvent utiliser cette méthode pour marquer la position courante le long du flux audio et l'afficher dans un aperçu.

int get_loop_count() const 🔗

Renvoie le nombre de fois que le flux a bouclé.

float get_playback_position() const 🔗

Renvoie la position actuelle dans le flux, en secondes.

AudioSamplePlayback get_sample_playback() const 🔗

Expérimental : Cette méthode peut être changée ou retirée dans de futures versions.

Renvoie l'AudioSamplePlayback associé à ce AudioStreamPlayback pour lire l'échantillon audio de ce flux.

bool is_playing() const 🔗

Renvoie true si le flux joue.

PackedVector2Array mix_audio(rate_scale: float, frames: int) 🔗

Mixe jusqu'à frames trames d'audio à partir du flux de la position actuelle, à une vitesse de rate_scale, en avançant le flux.

Renvoie un PackedVector2Array où chaque élément contient les niveaux de volume du canal gauche et droit de chaque trame.

Note : Peut renvoyer moins de trames que demandé, assurez-vous s'utilise la taille de la valeur renvoyée.

void seek(time: float = 0.0) 🔗

Avance le flux au temps time donné, en secondes.

void set_sample_playback(playback_sample: AudioSamplePlayback) 🔗

Expérimental : Cette méthode peut être changée ou retirée dans de futures versions.

Associe l'AudioSamplePlayback à ce AudioStreamPlayback pour jouer l'échantillon audio de ce flux.

void start(from_pos: float = 0.0) 🔗

Démarre le flux depuis la position from_pos donnée, en secondes.

void stop() 🔗

Arrête le flux.