virtualx-engine/modules/webm/doc_classes/VideoStreamWebm.xml

34 lines
1.5 KiB
XML
Raw Normal View History

2017-11-15 20:35:18 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamWebm" inherits="VideoStream" version="3.2">
2017-11-15 20:35:18 +01:00
<brief_description>
[VideoStream] resource for WebM videos.
2017-11-15 20:35:18 +01:00
</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]
2017-11-15 20:35:18 +01:00
</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>
2017-11-15 20:35:18 +01:00
</methods>
<constants>
</constants>
</class>