| github_url: | hide |
|---|
Inherits: :ref:`Resource<class_Resource>` < :ref:`RefCounted<class_RefCounted>` < :ref:`Object<class_Object>`
Inherited By: :ref:`VideoStreamTheora<class_VideoStreamTheora>`
Base resource for video streams.
.. rst-class:: classref-introduction-group
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>`.
.. rst-class:: classref-introduction-group
.. rst-class:: classref-reftable-group
| :ref:`String<class_String>` | :ref:`file<class_VideoStream_property_file>` | "" |
.. rst-class:: classref-reftable-group
| :ref:`VideoStreamPlayback<class_VideoStreamPlayback>` | :ref:`_instantiate_playback<class_VideoStream_method__instantiate_playback>` ( ) |virtual| |
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-property
:ref:`String<class_String>` file = ""
.. rst-class:: classref-property-setget
- void set_file ( :ref:`String<class_String>` value )
- :ref:`String<class_String>` get_file ( )
The video file path or URI that this VideoStream resource handles.
For :ref:`VideoStreamTheora<class_VideoStreamTheora>`, this filename should be an Ogg Theora video file with the .ogv extension.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
:ref:`VideoStreamPlayback<class_VideoStreamPlayback>` _instantiate_playback ( ) |virtual|
Called when the video starts playing, to initialize and return a subclass of :ref:`VideoStreamPlayback<class_VideoStreamPlayback>`.