Files
godot-docs-l10n/classes/fr/class_videostreamplayer.rst

402 lines
15 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_VideoStreamPlayer:
VideoStreamPlayer
=================
**Hérite de:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Un contrôle utilisé pour la lecture vidéo.
.. rst-class:: classref-introduction-group
Description
-----------
Un contrôle utilisé pour la lecture des ressources :ref:`VideoStream<class_VideoStream>`.
Les formats vidéo supportés sont `Ogg Theora <https://www.theora.org/>`__ (``.ogv``, :ref:`VideoStreamTheora<class_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.
.. rst-class:: classref-introduction-group
Tutoriels
------------------
- :doc:`Lire des vidéos <../tutorials/animation/playing_videos>`
.. rst-class:: classref-reftable-group
Propriétés
--------------------
.. table::
:widths: auto
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`int<class_int>` | :ref:`audio_track<class_VideoStreamPlayer_property_audio_track>` | ``0`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_VideoStreamPlayer_property_autoplay>` | ``false`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`int<class_int>` | :ref:`buffering_msec<class_VideoStreamPlayer_property_buffering_msec>` | ``500`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`StringName<class_StringName>` | :ref:`bus<class_VideoStreamPlayer_property_bus>` | ``&"Master"`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`expand<class_VideoStreamPlayer_property_expand>` | ``false`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`loop<class_VideoStreamPlayer_property_loop>` | ``false`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`bool<class_bool>` | :ref:`paused<class_VideoStreamPlayer_property_paused>` | ``false`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_VideoStreamPlayer_property_speed_scale>` | ``1.0`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`VideoStream<class_VideoStream>` | :ref:`stream<class_VideoStreamPlayer_property_stream>` | |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`stream_position<class_VideoStreamPlayer_property_stream_position>` | |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`volume<class_VideoStreamPlayer_property_volume>` | |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_VideoStreamPlayer_property_volume_db>` | ``0.0`` |
+---------------------------------------+--------------------------------------------------------------------------+---------------+
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+-----------------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stream_length<class_VideoStreamPlayer_method_get_stream_length>`\ (\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_stream_name<class_VideoStreamPlayer_method_get_stream_name>`\ (\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`get_video_texture<class_VideoStreamPlayer_method_get_video_texture>`\ (\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_VideoStreamPlayer_method_is_playing>`\ (\ ) |const| |
+-----------------------------------+------------------------------------------------------------------------------------------+
| |void| | :ref:`play<class_VideoStreamPlayer_method_play>`\ (\ ) |
+-----------------------------------+------------------------------------------------------------------------------------------+
| |void| | :ref:`stop<class_VideoStreamPlayer_method_stop>`\ (\ ) |
+-----------------------------------+------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signaux
--------------
.. _class_VideoStreamPlayer_signal_finished:
.. rst-class:: classref-signal
**finished**\ (\ ) :ref:`🔗<class_VideoStreamPlayer_signal_finished>`
Émis lorsque la lecture est terminée.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés
------------------------------------------------------
.. _class_VideoStreamPlayer_property_audio_track:
.. rst-class:: classref-property
:ref:`int<class_int>` **audio_track** = ``0`` :ref:`🔗<class_VideoStreamPlayer_property_audio_track>`
.. rst-class:: classref-property-setget
- |void| **set_audio_track**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_audio_track**\ (\ )
La piste audio intégrée à lire.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_autoplay:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **autoplay** = ``false`` :ref:`🔗<class_VideoStreamPlayer_property_autoplay>`
.. rst-class:: classref-property-setget
- |void| **set_autoplay**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **has_autoplay**\ (\ )
Si ``true``, la lecture commence au chargement de la scène.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_buffering_msec:
.. rst-class:: classref-property
:ref:`int<class_int>` **buffering_msec** = ``500`` :ref:`🔗<class_VideoStreamPlayer_property_buffering_msec>`
.. rst-class:: classref-property-setget
- |void| **set_buffering_msec**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_buffering_msec**\ (\ )
La durée en millisecondes à stocker dans la mémoire lors de la lecture.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_bus:
.. rst-class:: classref-property
:ref:`StringName<class_StringName>` **bus** = ``&"Master"`` :ref:`🔗<class_VideoStreamPlayer_property_bus>`
.. rst-class:: classref-property-setget
- |void| **set_bus**\ (\ value\: :ref:`StringName<class_StringName>`\ )
- :ref:`StringName<class_StringName>` **get_bus**\ (\ )
Le bus audio pour la lecture de sons.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_expand:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **expand** = ``false`` :ref:`🔗<class_VideoStreamPlayer_property_expand>`
.. rst-class:: classref-property-setget
- |void| **set_expand**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_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.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_loop:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **loop** = ``false`` :ref:`🔗<class_VideoStreamPlayer_property_loop>`
.. rst-class:: classref-property-setget
- |void| **set_loop**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **has_loop**\ (\ )
Si ``true``, la vidéo redémarre quand elle atteint sa fin.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_paused:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **paused** = ``false`` :ref:`🔗<class_VideoStreamPlayer_property_paused>`
.. rst-class:: classref-property-setget
- |void| **set_paused**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_paused**\ (\ )
Si ``true``, la vidéo est en pause.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_speed_scale:
.. rst-class:: classref-property
:ref:`float<class_float>` **speed_scale** = ``1.0`` :ref:`🔗<class_VideoStreamPlayer_property_speed_scale>`
.. rst-class:: classref-property-setget
- |void| **set_speed_scale**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_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 :ref:`paused<class_VideoStreamPlayer_property_paused>` à ``true``.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_stream:
.. rst-class:: classref-property
:ref:`VideoStream<class_VideoStream>` **stream** :ref:`🔗<class_VideoStreamPlayer_property_stream>`
.. rst-class:: classref-property-setget
- |void| **set_stream**\ (\ value\: :ref:`VideoStream<class_VideoStream>`\ )
- :ref:`VideoStream<class_VideoStream>` **get_stream**\ (\ )
Le flux vidéo assigné. Voir la description pour les formats supportés.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_stream_position:
.. rst-class:: classref-property
:ref:`float<class_float>` **stream_position** :ref:`🔗<class_VideoStreamPlayer_property_stream_position>`
.. rst-class:: classref-property-setget
- |void| **set_stream_position**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_stream_position**\ (\ )
La position actuelle du flux, en secondes.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_volume:
.. rst-class:: classref-property
:ref:`float<class_float>` **volume** :ref:`🔗<class_VideoStreamPlayer_property_volume>`
.. rst-class:: classref-property-setget
- |void| **set_volume**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_volume**\ (\ )
Le volume sonore comme valeur linéaire.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_property_volume_db:
.. rst-class:: classref-property
:ref:`float<class_float>` **volume_db** = ``0.0`` :ref:`🔗<class_VideoStreamPlayer_property_volume_db>`
.. rst-class:: classref-property-setget
- |void| **set_volume_db**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_volume_db**\ (\ )
Volume audio en dB.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_VideoStreamPlayer_method_get_stream_length:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_stream_length**\ (\ ) |const| :ref:`🔗<class_VideoStreamPlayer_method_get_stream_length>`
La longueur du flux courant, en secondes.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_method_get_stream_name:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_stream_name**\ (\ ) |const| :ref:`🔗<class_VideoStreamPlayer_method_get_stream_name>`
Renvoie le nom du flux vidéo, ou ``"<No Stream>"`` si aucun flux vidéo n'est assigné.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_method_get_video_texture:
.. rst-class:: classref-method
:ref:`Texture2D<class_Texture2D>` **get_video_texture**\ (\ ) |const| :ref:`🔗<class_VideoStreamPlayer_method_get_video_texture>`
Renvoie la trame actuelle en une :ref:`Texture<class_Texture>`.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_method_is_playing:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_playing**\ (\ ) |const| :ref:`🔗<class_VideoStreamPlayer_method_is_playing>`
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.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_method_play:
.. rst-class:: classref-method
|void| **play**\ (\ ) :ref:`🔗<class_VideoStreamPlayer_method_play>`
Commence la lecture vidéo dès le début. Si la vidéo est en pause, cela ne la fera pas reprendre.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamPlayer_method_stop:
.. rst-class:: classref-method
|void| **stop**\ (\ ) :ref:`🔗<class_VideoStreamPlayer_method_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.
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`