mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
55 lines
2.7 KiB
ReStructuredText
55 lines
2.7 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the VideoStreamTheora.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_VideoStreamTheora:
|
|
|
|
VideoStreamTheora
|
|
=================
|
|
|
|
**Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
:ref:`VideoStream<class_VideoStream>` resource for Ogg Theora videos.
|
|
|
|
Description
|
|
-----------
|
|
|
|
:ref:`VideoStream<class_VideoStream>` resource handling the `Ogg Theora <https://www.theora.org/>`__ video format with ``.ogv`` extension. 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.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-----------------------------+-------------------------------------------------------------------------------------------------------+
|
|
| :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 **)** |
|
|
+-----------------------------+-------------------------------------------------------------------------------------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_VideoStreamTheora_method_get_file:
|
|
|
|
- :ref:`String<class_String>` **get_file** **(** **)**
|
|
|
|
Returns the Ogg Theora video file handled by this ``VideoStreamTheora``.
|
|
|
|
----
|
|
|
|
.. _class_VideoStreamTheora_method_set_file:
|
|
|
|
- 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.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|