class_videostreamwebm.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VideoStreamWebm.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VideoStreamWebm:
  6. VideoStreamWebm
  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 WebM videos.
  10. Description
  11. -----------
  12. :ref:`VideoStream<class_VideoStream>` resource handling the `WebM <https://www.webmproject.org/>`_ video format with ``.webm`` extension.
  13. Methods
  14. -------
  15. +-----------------------------+-----------------------------------------------------------------------------------------------------+
  16. | :ref:`String<class_String>` | :ref:`get_file<class_VideoStreamWebm_method_get_file>` **(** **)** |
  17. +-----------------------------+-----------------------------------------------------------------------------------------------------+
  18. | void | :ref:`set_file<class_VideoStreamWebm_method_set_file>` **(** :ref:`String<class_String>` file **)** |
  19. +-----------------------------+-----------------------------------------------------------------------------------------------------+
  20. Method Descriptions
  21. -------------------
  22. .. _class_VideoStreamWebm_method_get_file:
  23. - :ref:`String<class_String>` **get_file** **(** **)**
  24. Returns the WebM video file handled by this ``VideoStreamWebm``.
  25. ----
  26. .. _class_VideoStreamWebm_method_set_file:
  27. - void **set_file** **(** :ref:`String<class_String>` file **)**
  28. Sets the WebM video file that this ``VideoStreamWebm`` resource handles. The ``file`` name should have the ``.webm`` extension.
  29. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  30. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  31. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`