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

VideoStreamPlayer

Hérite de : Control < CanvasItem < Node < Object

Un contrôle utilisé pour la lecture vidéo.

Description

Un contrôle utilisé pour la lecture des ressources VideoStream.

Les formats vidéo supportés sont Ogg Theora (.ogv, VideoStreamTheora) et tout format exposé par un plugin GDExtension.

Attention : Sur le Web, la lecture vidéo se produira mal en raison de l'absence d'optimisations d'assemblies spécifiques à l'architecture.

Tutoriels

Propriétés

int

audio_track

0

bool

autoplay

false

int

buffering_msec

500

StringName

bus

&"Master"

bool

expand

false

bool

loop

false

bool

paused

false

float

speed_scale

1.0

VideoStream

stream

float

stream_position

float

volume

float

volume_db

0.0

Méthodes

float

get_stream_length() const

String

get_stream_name() const

Texture2D

get_video_texture() const

bool

is_playing() const

void

play()

void

stop()

Signaux

finished() 🔗

Émis lorsque la lecture est terminée.

Descriptions des propriétés

int audio_track = 0 🔗

  • void set_audio_track(value: int)

  • int get_audio_track()

La piste audio intégrée à lire.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool has_autoplay()

Si true, la lecture commence au chargement de la scène.

int buffering_msec = 500 🔗

  • void set_buffering_msec(value: int)

  • int get_buffering_msec()

La durée en millisecondes à stocker dans la mémoire lors de la lecture.

StringName bus = &"Master" 🔗

Le bus audio pour la lecture de sons.

bool expand = false 🔗

  • void set_expand(value: bool)

  • bool has_expand()

Si true, la taille des contrôles dépendront de la vidéo. Sinon, la taille minimale des contrôles sera automatiquement ajustée pour correspondre aux dimensions du flux vidéo.

bool loop = false 🔗

  • void set_loop(value: bool)

  • bool has_loop()

Si true, la vidéo redémarre quand elle atteint sa fin.

bool paused = false 🔗

  • void set_paused(value: bool)

  • bool is_paused()

Si true, la vidéo est en pause.

float speed_scale = 1.0 🔗

  • void set_speed_scale(value: float)

  • float get_speed_scale()

L'échelle de vitesse actuelle du flux. 1.0 est la vitesse normale, tandis que 2.0 est une vitesse doublée et 0.5 est une vitesse divisée par 2. Une échelle de vitesse de 0.0 met en pause la vidéo, comme en définissant paused à true.

VideoStream stream 🔗

Le flux vidéo assigné. Voir la description pour les formats supportés.

float stream_position 🔗

  • void set_stream_position(value: float)

  • float get_stream_position()

La position actuelle du flux, en secondes.

float volume 🔗

  • void set_volume(value: float)

  • float get_volume()

Le volume sonore comme valeur linéaire.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

Volume audio en dB.

Descriptions des méthodes

float get_stream_length() const 🔗

La longueur du flux courant, en secondes.

String get_stream_name() const 🔗

Renvoie le nom du flux vidéo, ou "<No Stream>" si aucun flux vidéo n'est assigné.

Texture2D get_video_texture() const 🔗

Renvoie la trame actuelle en une Texture.

bool is_playing() const 🔗

Renvoie true si la vidéo joue.

Note : La vidéo est toujours considérée comme en train de jouer si elle est mise en pause pendant la lecture.

void play() 🔗

Commence la lecture vidéo dès le début. Si la vidéo est en pause, cela ne la fera pas reprendre.

void stop() 🔗

Arrête la lecture vidéo et fixe la position du flux à 0.

Note : Bien que la position du flux soit définie à 0, la première trame du flux vidéo ne deviendra pas le trame actuel.