summaryrefslogtreecommitdiff
path: root/modules/theora/doc_classes/VideoStreamTheora.xml
blob: e07af8f16926c0f6e408773eda2b7520174ce56b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
<?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>