doc: Complete documentation for VideoStreams

Also quick clean up of the matching C++ files.
This commit is contained in:
Rémi Verschelde
2020-01-26 11:24:14 +01:00
parent 55cc46a052
commit bb6c0d3e8b
16 changed files with 43 additions and 73 deletions

View File

@@ -1,8 +1,11 @@
<?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>
@@ -11,6 +14,7 @@
<return type="String">
</return>
<description>
Returns the video file handled by this [VideoStreamGDNative].
</description>
</method>
<method name="set_file">
@@ -19,6 +23,7 @@
<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>