summaryrefslogtreecommitdiff
path: root/doc/classes/VideoPlayer.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:24:14 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-01-26 11:29:07 +0100
commitbb6c0d3e8bb1982bce3e1c219c1a4a2d187227f0 (patch)
treeee58635301c11a4e5e46d99030e54cff3e4ca9ba /doc/classes/VideoPlayer.xml
parent55cc46a0523df8df85aa6ffec6b58ff86e5ab1af (diff)
doc: Complete documentation for VideoStreams
Also quick clean up of the matching C++ files.
Diffstat (limited to 'doc/classes/VideoPlayer.xml')
-rw-r--r--doc/classes/VideoPlayer.xml5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml
index 3ed53aa447..3bc3898b9f 100644
--- a/doc/classes/VideoPlayer.xml
+++ b/doc/classes/VideoPlayer.xml
@@ -4,7 +4,8 @@
Control for playing video streams.
</brief_description>
<description>
- Control node for playing video streams. Supported formats are [url=https://www.webmproject.org/]WebM[/url] and [url=https://www.theora.org/]Ogg Theora[/url].
+ Control node for playing video streams using [VideoStream] resources.
+ Supported video formats are [url=https://www.webmproject.org/]WebM[/url] ([VideoStreamWebm]), [url=https://www.theora.org/]Ogg Theora[/url] ([VideoStreamTheora]), and any format exposed via a GDNative plugin using [VideoStreamGDNative].
</description>
<tutorials>
</tutorials>
@@ -61,7 +62,7 @@
Audio bus to use for sound playback.
</member>
<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">
- If [code]true[/code], the video scales to the control size.
+ If [code]true[/code], the video scales to the control size. Otherwise, the control minimum size will be automatically adjusted to match the video stream's dimensions.
</member>
<member name="paused" type="bool" setter="set_paused" getter="is_paused" default="false">
If [code]true[/code], the video is paused.