class_videostreamgdnative.rst 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VideoStreamGDNative.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VideoStreamGDNative:
  6. VideoStreamGDNative
  7. ===================
  8. **Inherits:** :ref:`VideoStream<class_VideoStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. :ref:`VideoStream<class_VideoStream>` resource for for video formats implemented via GDNative.
  10. Description
  11. -----------
  12. :ref:`VideoStream<class_VideoStream>` resource for for video formats implemented via GDNative.
  13. It can be used via `godot-videodecoder <https://github.com/KidRigger/godot-videodecoder>`__ which uses the `FFmpeg <https://ffmpeg.org>`__ library.
  14. Methods
  15. -------
  16. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  17. | :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamGDNative_method_get_file>` **(** **)** |
  18. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_file<class_VideoStreamGDNative_method_set_file>` **(** :ref:`String<class_String>` file **)** |
  20. +-----------------------------+---------------------------------------------------------------------------------------------------------+
  21. Method Descriptions
  22. -------------------
  23. .. _class_VideoStreamGDNative_method_get_file:
  24. - :ref:`String<class_String>` **get_file** **(** **)**
  25. Returns the video file handled by this ``VideoStreamGDNative``.
  26. ----
  27. .. _class_VideoStreamGDNative_method_set_file:
  28. - void **set_file** **(** :ref:`String<class_String>` file **)**
  29. Sets the video file that this ``VideoStreamGDNative`` resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`