diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-01-18 15:27:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-18 15:27:28 +0100 |
| commit | d4a222cd9d849a63f0535f70cbf78700bc5c815b (patch) | |
| tree | f771aae88b95d19f24fc2092120e3b25e02f3f70 /doc | |
| parent | b154bc8333564a3b54c75d8abde12a7dfa1d6804 (diff) | |
| parent | ecf3d3fd8443fb863d145a93f3dba771809f1f85 (diff) | |
Merge pull request #35281 from timothyqiu/video-player-doc
Improves VideoPlayer's documentation
Diffstat (limited to 'doc')
| -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> |