2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 08:08:05 +00:00
<class name= "VideoStream" inherits= "Resource" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-08-26 22:31:09 +00:00
Base resource for video streams.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2021-12-06 16:24:45 +00:00
Base resource type for all video streams. Classes that derive from [VideoStream] can all be used as resource types to play back videos in [VideoStreamPlayer].
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2023-08-15 10:14:01 +00:00
<link title= "Playing videos" > $DOCS_URL/tutorials/animation/playing_videos.html</link>
2023-11-13 13:37:27 +00:00
<link title= "Runtime file loading and saving" > $DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
2022-07-28 22:23:11 +00:00
<methods >
<method name= "_instantiate_playback" qualifiers= "virtual" >
<return type= "VideoStreamPlayback" />
<description >
Called when the video starts playing, to initialize and return a subclass of [VideoStreamPlayback].
</description>
</method>
</methods>
<members >
<member name= "file" type= "String" setter= "set_file" getter= "get_file" default= """" >
The video file path or URI that this [VideoStream] resource handles.
For [VideoStreamTheora], this filename should be an Ogg Theora video file with the [code].ogv[/code] extension.
</member>
</members>
2017-09-12 20:42:36 +00:00
</class>
