mirror of
https://github.com/godotengine/godot
synced 2024-09-15 22:48:13 +00:00
27 lines
1.1 KiB
XML
27 lines
1.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="VideoStream" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Base resource for video streams.
|
|
</brief_description>
|
|
<description>
|
|
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].
|
|
</description>
|
|
<tutorials>
|
|
<link title="Playing videos">$DOCS_URL/tutorials/animation/playing_videos.html</link>
|
|
</tutorials>
|
|
<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>
|
|
</class>
|