class_videostream.rst 1.4 KB

12345678910111213141516171819202122232425262728
  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 VideoStream.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VideoStream:
  6. VideoStream
  7. ===========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`VideoStreamTheora<class_VideoStreamTheora>`
  10. Base resource for video streams.
  11. Description
  12. -----------
  13. Base resource type for all video streams. Classes that derive from ``VideoStream`` can all be used as resource types to play back videos in :ref:`VideoStreamPlayer<class_VideoStreamPlayer>`.
  14. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  15. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  16. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  17. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  18. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  19. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`