virtualx-engine/modules/webm/doc_classes/VideoStreamWebm.xml
Rémi Verschelde bb6c0d3e8b doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
2020-01-26 11:29:07 +01:00

31 lines
961 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamWebm" inherits="VideoStream" category="Core" version="3.2">
<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.
</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>