class_videostreamgdnative.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/gdnative/doc_classes/VideoStreamGDNative.xml.
  6. .. _class_VideoStreamGDNative:
  7. VideoStreamGDNative
  8. ===================
  9. **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. :ref:`VideoStream<class_VideoStream>` resource for video formats implemented via GDNative.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. :ref:`VideoStream<class_VideoStream>` resource for video formats implemented via GDNative.
  15. It can be used via `godot-videodecoder <https://github.com/KidRigger/godot-videodecoder>`__ which uses the `FFmpeg <https://ffmpeg.org>`__ library.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  22. | :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamGDNative_method_get_file>` **(** **)** |
  23. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`set_file<class_VideoStreamGDNative_method_set_file>` **(** :ref:`String<class_String>` file **)** |
  25. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  26. .. rst-class:: classref-section-separator
  27. ----
  28. .. rst-class:: classref-descriptions-group
  29. Method Descriptions
  30. -------------------
  31. .. _class_VideoStreamGDNative_method_get_file:
  32. .. rst-class:: classref-method
  33. :ref:`String<class_String>` **get_file** **(** **)**
  34. Returns the video file handled by this **VideoStreamGDNative**.
  35. .. rst-class:: classref-item-separator
  36. ----
  37. .. _class_VideoStreamGDNative_method_set_file:
  38. .. rst-class:: classref-method
  39. void **set_file** **(** :ref:`String<class_String>` file **)**
  40. Sets the video file that this **VideoStreamGDNative** resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`