godot/doc/classes/VideoStream.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStream" inherits="Resource" version="4.0" 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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="VideoStream" inherits="Resource" version="4.0" 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 20:42:36 +00:00			`<brief_description>`
[DOCS] Corrections and clarifications 2018-08-26 22:31:09 +00: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 20:42:36 +00: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 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].`
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 20:42:36 +00: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-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>`
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 20:42:36 +00:00			`</class>`