| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/theora/doc_classes/VideoStreamTheora.xml.
- .. _class_VideoStreamTheora:
- VideoStreamTheora
- =================
- **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- :ref:`VideoStream<class_VideoStream>` resource for Ogg Theora videos.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- :ref:`VideoStream<class_VideoStream>` resource handling the `Ogg Theora <https://www.theora.org/>`__ video format with ``.ogv`` extension. The Theora codec is less efficient than :ref:`VideoStreamWebm<class_VideoStreamWebm>`'s VP8 and VP9, but it requires less CPU resources to decode. The Theora codec is decoded on the CPU.
- \ **Note:** While Ogg Theora videos can also have an ``.ogg`` extension, you will have to rename the extension to ``.ogv`` to use those videos within Godot.
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-----------------------------+-------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamTheora_method_get_file>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_file<class_VideoStreamTheora_method_set_file>` **(** :ref:`String<class_String>` file **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_VideoStreamTheora_method_get_file:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **get_file** **(** **)**
- Returns the Ogg Theora video file handled by this **VideoStreamTheora**.
- .. rst-class:: classref-item-separator
- ----
- .. _class_VideoStreamTheora_method_set_file:
- .. rst-class:: classref-method
- void **set_file** **(** :ref:`String<class_String>` file **)**
- Sets the Ogg Theora video file that this **VideoStreamTheora** resource handles. The ``file`` name should have the ``.ogv`` 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.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
