summaryrefslogtreecommitdiff
path: root/doc/classes/VideoPlayer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/VideoPlayer.xml')
-rw-r--r--doc/classes/VideoPlayer.xml22
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml
index 15d1dfcf19..45341cee74 100644
--- a/doc/classes/VideoPlayer.xml
+++ b/doc/classes/VideoPlayer.xml
@@ -4,7 +4,7 @@
Control for playing video streams.
</brief_description>
<description>
- Control node for playing video streams. Supported formats are WebM and OGV Theora.
+ 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].
</description>
<tutorials>
</tutorials>
@@ -46,25 +46,25 @@
</method>
</methods>
<members>
- <member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track">
+ <member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track" default="0">
The embedded audio track to play.
</member>
- <member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
- If [code]true[/code], playback starts when the scene loads. Default value: [code]false[/code].
+ <member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay" default="false">
+ If [code]true[/code], playback starts when the scene loads.
</member>
- <member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec">
+ <member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec" default="500">
Amount of time in milliseconds to store in buffer while playing.
</member>
- <member name="bus" type="String" setter="set_bus" getter="get_bus">
+ <member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
Audio bus to use for sound playback.
</member>
- <member name="expand" type="bool" setter="set_expand" getter="has_expand">
- If [code]true[/code], the video scales to the control size. Default value: [code]true[/code].
+ <member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">
+ If [code]true[/code], the video scales to the control size.
</member>
- <member name="paused" type="bool" setter="set_paused" getter="is_paused">
+ <member name="paused" type="bool" setter="set_paused" getter="is_paused" default="false">
If [code]true[/code], the video is paused.
</member>
- <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
+ <member name="stream" type="VideoStream" setter="set_stream" getter="get_stream" default="null">
</member>
<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
The current position of the stream, in seconds.
@@ -72,7 +72,7 @@
<member name="volume" type="float" setter="set_volume" getter="get_volume">
Audio volume as a linear value.
</member>
- <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
+ <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
Audio volume in dB.
</member>
</members>