virtualx-engine/modules/gdnative/doc_classes/VideoStreamGDNative.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

32 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoStreamGDNative" inherits="VideoStream" category="Core" version="3.2">
<brief_description>
[VideoStream] resource for for video formats implemented via GDNative.
</brief_description>
<description>
[VideoStream] resource for for video formats implemented via GDNative.
It can be used via [url=https://github.com/KidRigger/godot-videodecoder]godot-videodecoder[/url] which uses the [url=https://ffmpeg.org]FFmpeg[/url] library.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_file">
<return type="String">
</return>
<description>
Returns the video file handled by this [VideoStreamGDNative].
</description>
</method>
<method name="set_file">
<return type="void">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats.
</description>
</method>
</methods>
<constants>
</constants>
</class>