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

VideoStreamPlayback

Hérite de : Resource < RefCounted < Object

Classe interne utilisée par VideoStream pour gérer l'état de lecture lorsque joué depyis un VideoStreamPlayer.

Description

Cette classe est destinée à être redéfinie par des extensions de décodeur vidéo avec des implémentations personnalisées de VideoStream.

Méthodes

int	_get_channels() virtual const
float	_get_length() virtual const
int	_get_mix_rate() virtual const
float	_get_playback_position() virtual const
Texture2D	_get_texture() virtual const
bool	_is_paused() virtual const
bool	_is_playing() virtual const
void	_play() virtual
void	_seek(time: float) virtual
void	_set_audio_track(idx: int) virtual
void	_set_paused(paused: bool) virtual
void	_stop() virtual
void	_update(delta: float) virtual required
int	mix_audio(num_frames: int, buffer: PackedFloat32Array = PackedFloat32Array(), offset: int = 0)

Descriptions des méthodes

int _get_channels() virtual const 🔗

Renvoie le nombre de canaux audio.

float _get_length() virtual const 🔗

Renvoie la durée de la vidéo en secondes, si elle est connue, ou 0 si elle est inconnue.

int _get_mix_rate() virtual const 🔗

Renvoie le taux d'échantillonnage audio utilisé pour le mixage.

float _get_playback_position() virtual const 🔗

Renvoie l’horodatage de lecture actuel. Appelée en réponse au getter VideoStreamPlayer.stream_position.

Texture2D _get_texture() virtual const 🔗

Alloue une Texture2D dans laquelle les trames vidéos décodées seront dessinées.

bool _is_paused() virtual const 🔗

Renvoie le statut de pause, tel que défini par _set_paused().

bool _is_playing() virtual const 🔗

Renvoie l'état de la lecture, tel que déterminé par les appels à _play() et _stop().

void _play() virtual 🔗

Appelée en réponse à VideoStreamPlayer.autoplay ou VideoStreamPlayer.play(). Notez que la lecture manuelle peut également invoquer _stop() plusieurs fois avant que cette méthode soit appelée. _is_playing() devrait renvoyer true lors de la lecture.

void _seek(time: float) virtual 🔗

Se rend au temps time, en secondes. Appelée en réponse au setter VideoStreamPlayer.stream_position.

void _set_audio_track(idx: int) virtual 🔗

Sélectionne la piste audio d'index idx. Appelée quand la lecture commence, et en réponse au setter de VideoStreamPlayer.audio_track.

void _set_paused(paused: bool) virtual 🔗

Définit l'état de la pause de la lecture vidéo. _is_paused() doit renvoyer paused. Appelée en réponse au setter de VideoStreamPlayer.paused.

void _stop() virtual 🔗

Arrête la lecture. Peut être appelée plusieurs fois avant _play(), ou en réponse à VideoStreamPlayer.stop(). _is_playing() devrait renvoyer false une fois arrêtée.

void _update(delta: float) virtual required 🔗

Avance la lecture vidéo de delta secondes. Appelée à chaque trame tant que _is_paused() et _is_playing() renvoient true.

int mix_audio(num_frames: int, buffer: PackedFloat32Array = PackedFloat32Array(), offset: int = 0) 🔗

Rend num_frames trames audio (de _get_channels() flottants chacun) du buffer, à partir de l'index offset dans le tableau. Renvoie le nombre de trames audio rendues, ou -1 lors d'une erreur.