godot/modules/theora/doc_classes/VideoStreamTheora.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamTheora" inherits="VideoStream" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		[VideoStream] resource for Ogg Theora videos.
	</brief_description>
	<description>
		[VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension. The Theora codec is decoded on the CPU.
		[b]Note:[/b] While Ogg Theora videos can also have an [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_file">
			<return type="String" />
			<description>
				Returns the Ogg Theora video file handled by this [VideoStreamTheora].
			</description>
		</method>
		<method name="set_file">
			<return type="void" />
			<param index="0" name="file" type="String" />
			<description>
				Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension.
			</description>
		</method>
	</methods>
</class>
doc: Sync classref with current source 2017-11-15 19:35:18 +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="VideoStreamTheora" inherits="VideoStream" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
doc: Sync classref with current source 2017-11-15 19:35:18 +00:00			`<brief_description>`
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files. 2020-01-26 10:24:14 +00:00			`[VideoStream] resource for Ogg Theora videos.`
doc: Sync classref with current source 2017-11-15 19:35:18 +00:00			`</brief_description>`
			`<description>`
Remove WebM support (and deps libvpx and opus) We've had many issues with WebM support and specifically the libvpx library over the years, mostly due to its poor integration in Godot's buildsystem, but without anyone really interested in improving this state. With the new GDExtensions in Godot 4.0, we intend to move video decoding to first-party extensions, and this would likely be done using something like libvlc to expose more codecs. Removing the `webm` module means we can remove libsimplewebm, libvpx and opus, which we were only used for that purpose. Both libvpx and opus were fairly complex pieces of the buildsystem, so this is a nice cleanup. This also removes the compile-time dependency on `yasm`. Fixes lots of compilation or non-working WebM issues which will be linked in the PR. 2021-10-15 10:05:32 +00:00			`[VideoStream] resource handling the [url=https://www.theora.org/]Ogg Theora[/url] video format with [code].ogv[/code] extension. The Theora codec is decoded on the CPU.`
Improve documentation about VideoPlayer video formats This closes https://github.com/godotengine/godot-docs/issues/4021. 2020-09-16 20:41:48 +00:00			`[b]Note:[/b] While Ogg Theora videos can also have an [code].ogg[/code] extension, you will have to rename the extension to [code].ogv[/code] to use those videos within Godot.`
doc: Sync classref with current source 2017-11-15 19:35:18 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 07:29:38 +00:00			`<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. 2021-07-30 13:28:05 +00:00			`<return type="String" />`
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 07:29:38 +00:00			`<description>`
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files. 2020-01-26 10:24:14 +00:00			`Returns the Ogg Theora video file handled by this [VideoStreamTheora].`
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 07:29:38 +00: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. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="file" type="String" />`
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 07:29:38 +00:00			`<description>`
Improve documentation about VideoPlayer video formats This closes https://github.com/godotengine/godot-docs/issues/4021. 2020-09-16 20:41:48 +00:00			`Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension.`
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 07:29:38 +00:00			`</description>`
			`</method>`
doc: Sync classref with current source 2017-11-15 19:35:18 +00:00			`</methods>`
			`</class>`