| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the VideoStreamWebm.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_VideoStreamWebm:
- VideoStreamWebm
- ===============
- **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- :ref:`VideoStream<class_VideoStream>` resource for WebM videos.
- Description
- -----------
- :ref:`VideoStream<class_VideoStream>` resource handling the `WebM <https://www.webmproject.org/>`__ video format with ``.webm`` extension. Both the VP8 and VP9 codecs are supported. The VP8 and VP9 codecs are more efficient than :ref:`VideoStreamTheora<class_VideoStreamTheora>`, but they require more CPU resources to decode (especially VP9). Both the VP8 and VP9 codecs are decoded on the CPU.
- **Note:** Alpha channel (also known as transparency) is not supported. The video will always appear to have a black background, even if it originally contains an alpha channel.
- **Note:** There are known bugs and performance issues with WebM video playback in Godot. If you run into problems, try using the Ogg Theora format instead: :ref:`VideoStreamTheora<class_VideoStreamTheora>`
- Methods
- -------
- +-----------------------------+-----------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamWebm_method_get_file>` **(** **)** |
- +-----------------------------+-----------------------------------------------------------------------------------------------------+
- | void | :ref:`set_file<class_VideoStreamWebm_method_set_file>` **(** :ref:`String<class_String>` file **)** |
- +-----------------------------+-----------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_VideoStreamWebm_method_get_file:
- - :ref:`String<class_String>` **get_file** **(** **)**
- Returns the WebM video file handled by this ``VideoStreamWebm``.
- ----
- .. _class_VideoStreamWebm_method_set_file:
- - void **set_file** **(** :ref:`String<class_String>` file **)**
- Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
