diff options
| author | Haoyu Qiu <timothyqiu32@gmail.com> | 2020-01-18 21:51:17 +0800 |
|---|---|---|
| committer | Haoyu Qiu <timothyqiu32@gmail.com> | 2020-01-18 21:51:17 +0800 |
| commit | ecf3d3fd8443fb863d145a93f3dba771809f1f85 (patch) | |
| tree | 46c6fe8b3c9be1ef17197850132c0edaf8210f80 | |
| parent | bc4ce44d771b99f1ac8d49901630bf3d3c343c8a (diff) | |
Improves VideoPlayer's documentation
| -rw-r--r-- | doc/classes/VideoPlayer.xml | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 804489f7f1..3ed53aa447 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -13,7 +13,7 @@ <return type="String"> </return> <description> - Returns the video stream's name. + Returns the video stream's name, or [code]"<No Stream>"[/code] if no video stream is assigned. </description> </method> <method name="get_video_texture" qualifiers="const"> @@ -28,20 +28,22 @@ </return> <description> Returns [code]true[/code] if the video is playing. + [b]Note:[/b] The video is still considered playing if paused during playback. </description> </method> <method name="play"> <return type="void"> </return> <description> - Starts the video playback. + Starts the video playback from the beginning. If the video is paused, this will not unpause the video. </description> </method> <method name="stop"> <return type="void"> </return> <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> </method> </methods> |