godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/VideoPlayer.xml

91 lines
4.1 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 16:51:38 +00:00
<class name="VideoPlayer" inherits="Control" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Control for playing video streams.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files.
2020-01-26 10:24:14 +00:00
Control node for playing video streams using [VideoStream] resources.
Improve documentation about VideoPlayer video formats This closes https://github.com/godotengine/godot-docs/issues/4021. (cherry picked from commit 1efe57848a00da704300d4c6c4448984e0d2d03c)
2020-09-16 20:41:48 +00:00
Supported video formats are [url=https://www.webmproject.org/]WebM[/url] ([code].webm[/code], [VideoStreamWebm]), [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]), and any format exposed via a GDNative plugin using [VideoStreamGDNative].
Document the lack of localization remapping support in VideoPlayer See #43917. (cherry picked from commit 1636fb8856759495aaeb156517d9a4cd2a33b967)
2020-11-27 14:56:24 +00:00
[b]Note:[/b] Due to a bug, VideoPlayer does not support localization remapping yet.
Document the expected low performance of VideoPlayer on HTML5 (cherry picked from commit b98540dd9da416d1cc94e9f084e96e68b089aecd)
2020-12-25 10:59:37 +00:00
[b]Warning:[/b] On HTML5, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations, especially for VP8/VP9.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_stream_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Improves VideoPlayer's documentation
2020-01-18 13:51:17 +00:00
Returns the video stream's name, or [code]"&lt;No Stream&gt;"[/code] if no video stream is assigned.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source
2019-10-26 14:40:31 +00:00
<method name="get_video_texture" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="Texture" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Returns the current frame as a [Texture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="is_playing" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Returns [code]true[/code] if the video is playing.
Improves VideoPlayer's documentation
2020-01-18 13:51:17 +00:00
[b]Note:[/b] The video is still considered playing if paused during playback.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="play">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Improves VideoPlayer's documentation
2020-01-18 13:51:17 +00:00
Starts the video playback from the beginning. If the video is paused, this will not unpause the video.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="stop">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Improves VideoPlayer's documentation
2020-01-18 13:51:17 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track" default="0">
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
The embedded audio track to play.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If [code]true[/code], playback starts when the scene loads.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec" default="500">
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Amount of time in milliseconds to store in buffer while playing.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Audio bus to use for sound playback.
doc: Sync classref with current source
2017-11-15 19:35:18 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">
doc: Complete documentation for VideoStreams Also quick clean up of the matching C++ files.
2020-01-26 10:24:14 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="paused" type="bool" setter="set_paused" getter="is_paused" default="false">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the video is paused.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
[DOC] Fill in various missing method/member descriptions.
2019-10-06 23:26:15 +00:00
The assigned video stream. See description for supported formats.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
The current position of the stream, in seconds.
Print a warning when trying to seek in VideoPlayer Seeking isn't implemented in built-in video formats and can only be supported in GDNative-provided video formats. (cherry picked from commit ea46639e22b83ff18d7b85c67b732f6e82ae7df3)
2021-04-14 18:39:13 +00:00
[b]Note:[/b] Changing this value won't have any effect as seeking is not implemented yet, except in video formats implemented by a GDNative add-on.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="volume" type="float" setter="set_volume" getter="get_volume">
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Audio volume as a linear value.
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Audio volume in dB.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
<signals>
<signal name="finished">
<description>
[DOCS] Update VideoPlayer classref
2018-05-20 20:43:48 +00:00
Emitted when playback is finished.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
</class>