virtualx-engine/doc/classes/VideoStream.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStream" inherits="Resource" version="4.1" 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>
	</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="&quot;&quot;">
			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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 01:44:37 +01:00			`<class name="VideoStream" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
[DOCS] Corrections and clarifications 2018-08-27 00:31:09 +02:00			`Base resource for video streams.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Rename `VideoPlayer` to `VideoStreamPlayer` for consistency It's a player for `VideoStream` resources, just like `AudioStreamPlayer` is a player for `AudioStream` resources. Closes https://github.com/godotengine/godot-proposals/issues/3624. 2021-12-06 17:24:45 +01: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].`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
Updates VideoDecoder plugin API to GDExtension. Adds VideoStream and relevant resource loaders to migrate external GDNative plugins to GDExtension. Adds a VideoStreamLoader as a specialization of ResourceFormatLoader as ClassDB::is_parent_class is inaccessible from GDExtension currently. Using Object* instead of Ref<T> in order to avoid the refcount bug (godotengine/godot-cpp#652) Also another bug is in ResourceLoader in use on the extension side that requires fixing. 2022-07-29 00:23:11 +02: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>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</class>`