virtualx-engine-docs/_sources/classes/class_videostreamgdnative.rst.txt
2024-10-23 09:41:33 -07:00

72 lines
2.8 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/VideoStreamGDNative.xml.
.. _class_VideoStreamGDNative:
VideoStreamGDNative
===================
**Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
:ref:`VideoStream<class_VideoStream>` resource for video formats implemented via GDNative.
.. rst-class:: classref-introduction-group
Description
-----------
:ref:`VideoStream<class_VideoStream>` resource for video formats implemented via GDNative.
It can be used via `godot-videodecoder <https://github.com/KidRigger/godot-videodecoder>`__ which uses the `FFmpeg <https://ffmpeg.org>`__ library.
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-----------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamGDNative_method_get_file>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_file<class_VideoStreamGDNative_method_set_file>` **(** :ref:`String<class_String>` file **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_VideoStreamGDNative_method_get_file:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_file** **(** **)**
Returns the video file handled by this **VideoStreamGDNative**.
.. rst-class:: classref-item-separator
----
.. _class_VideoStreamGDNative_method_set_file:
.. rst-class:: classref-method
void **set_file** **(** :ref:`String<class_String>` file **)**
Sets the video file that this **VideoStreamGDNative** resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
.. |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.)`