asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Improves VideoPlayer's documentation

Browse source
This commit is contained in:
Haoyu Qiu 2020-01-18 21:51:17 +08:00
parent bc4ce44d77
commit ecf3d3fd84
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/VideoPlayer.xml
View file

@ -13,7 +13,7 @@
<return type="String"> <return type="String">
</return> </return>
<description> <description>
Returns the video stream's name. Returns the video stream's name, or [code]"&lt;No Stream&gt;"[/code] if no video stream is assigned.
</description> </description>
</method> </method>
<method name="get_video_texture" qualifiers="const"> <method name="get_video_texture" qualifiers="const">
@ -28,20 +28,22 @@
</return> </return>
<description> <description>
Returns [code]true[/code] if the video is playing. Returns [code]true[/code] if the video is playing.
[b]Note:[/b] The video is still considered playing if paused during playback.
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Starts the video playback. Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Stops the video playback. Stops the video playback and sets the stream position to 0.
[b]Note:[/b] Although the stream position will be set to 0, the first frame of the video stream won't become the current frame.
</description> </description>
</method> </method>
</methods> </methods>