For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5
)
29 lines
1 KiB
XML
29 lines
1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="VideoStreamGDNative" inherits="VideoStream" version="3.4">
|
|
<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" />
|
|
<description>
|
|
Returns the video file handled by this [VideoStreamGDNative].
|
|
</description>
|
|
</method>
|
|
<method name="set_file">
|
|
<return type="void" />
|
|
<argument index="0" name="file" type="String" />
|
|
<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>
|