virtualx-engine/modules/gdnative/doc_classes/VideoStreamGDNative.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamGDNative" inherits="VideoStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		[VideoStream] resource for video formats implemented via GDNative.
	</brief_description>
	<description>
		[VideoStream] resource for video formats implemented via GDNative.
		It can be used via [url=https://github.com/KidRigger/godot-videodecoder]godot-videodecoder[/url] which uses the [url=https://ffmpeg.org]FFmpeg[/url] library.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_file">
			<return type="String" />
			<description>
				Returns the video file handled by this [VideoStreamGDNative].
			</description>
		</method>
		<method name="set_file">
			<return type="void" />
			<argument index="0" name="file" type="String" />
			<description>
				Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01: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-03-16 23:01:02 +01:00			`<class name="VideoStreamGDNative" inherits="VideoStream" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`<brief_description>`
Fix various typos 2022-05-19 11:03:57 +02:00			`[VideoStream] resource for video formats implemented via GDNative.`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`</brief_description>`
			`<description>`
Fix various typos 2022-05-19 11:03:57 +02:00			`[VideoStream] resource for video formats implemented via GDNative.`
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files. 2020-01-26 11:24:14 +01:00			`It can be used via [url=https://github.com/KidRigger/godot-videodecoder]godot-videodecoder[/url] which uses the [url=https://ffmpeg.org]FFmpeg[/url] library.`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`<method name="get_file">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="String" />`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`<description>`
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files. 2020-01-26 11:24:14 +01:00			`Returns the video file handled by this [VideoStreamGDNative].`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`</description>`
			`</method>`
			`<method name="set_file">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85) 2021-07-30 15:28:05 +02:00			`<return type="void" />`
			`<argument index="0" name="file" type="String" />`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`<description>`
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files. 2020-01-26 11:24:14 +01:00			`Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.`
doc: Sync classref with current source + AUTHORS edit 2019-01-10 14:34:15 +01:00			`</description>`
			`</method>`
			`</methods>`
			`<constants>`
			`</constants>`
			`</class>`