summaryrefslogtreecommitdiff
path: root/modules/webm/doc_classes/VideoStreamWebm.xml
blob: f3e13ba31ae0313b63aae2199c24c6a405723ab0 (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
28
29
30
31
32
33
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamWebm" inherits="VideoStream" version="4.0">
	<brief_description>
		[VideoStream] resource for WebM videos.
	</brief_description>
	<description>
		[VideoStream] resource handling the [url=https://www.webmproject.org/]WebM[/url] video format with [code].webm[/code] extension. Both the VP8 and VP9 codecs are supported. The VP8 and VP9 codecs are more efficient than [VideoStreamTheora], but they require more CPU resources to decode (especially VP9). Both the VP8 and VP9 codecs are decoded on the CPU.
		[b]Note:[/b] Alpha channel (also known as transparency) is not supported. The video will always appear to have a black background, even if it originally contains an alpha channel.
		[b]Note:[/b] There are known bugs and performance issues with WebM video playback in Godot. If you run into problems, try using the Ogg Theora format instead: [VideoStreamTheora]
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_file">
			<return type="String">
			</return>
			<description>
				Returns the WebM video file handled by this [VideoStreamWebm].
			</description>
		</method>
		<method name="set_file">
			<return type="void">
			</return>
			<argument index="0" name="file" type="String">
			</argument>
			<description>
				Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>