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

100 lines
4.6 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" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="VideoStreamPlayer" inherits="Control" 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>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A control used for video 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
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A control used for playback of [VideoStream] resources.
Remove unused GDNative code This has been superseded by GDExtension so this code is no longer useful nor usable. There's still some GDNative-related stuff in platform export code which needs to be adapted for GDExtension (e.g. to include GDExtension libraries in exports).
2022-03-09 12:56:14 +00:00
Supported video formats are [url=https://www.theora.org/]Ogg Theora[/url] ([code].ogv[/code], [VideoStreamTheora]) and any format exposed via a GDExtension plugin.
Rename `VideoPlayer` to `VideoStreamPlayer` for consistency It's a player for `VideoStream` resources, just like `AudioStreamPlayer` is a player for `AudioStream` resources. Closes https://github.com/godotengine/godot-proposals/issues/3624.
2021-12-06 16:24:45 +00:00
[b]Note:[/b] Due to a bug, VideoStreamPlayer does not support localization remapping yet.
[Web] Rename JavaScript platform to Web. Also rename export name from "HTML5" to "Web".
2022-08-28 18:27:45 +00:00
[b]Warning:[/b] On Web, video playback [i]will[/i] perform poorly due to missing architecture-specific assembly optimizations.
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>
Add missing tutorials to documentation classes
2023-08-15 10:14:01 +00:00
<link title="Playing videos">$DOCS_URL/tutorials/animation/playing_videos.html</link>
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
</tutorials>
<methods>
Expose VideoStreamPlayer video length
2023-06-04 22:59:23 +00:00
<method name="get_stream_length" qualifiers="const">
<return type="float" />
<description>
The length of the current stream, in seconds.
[b]Note:[/b] For [VideoStreamTheora] streams (the built-in format supported by Godot), this value will always be zero, as getting the stream length is not implemented yet. The feature may be supported by video formats implemented by a GDExtension add-on.
</description>
</method>
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
<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.
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.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
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>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
Returns the current frame as a [Texture2D].
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.
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.
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.
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>
Let var2str display StringName with correct sigil
2021-06-05 19:24:24 +00:00
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&amp;&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>
Disable Expand by default in VideoStreamPlayer This ensures videos are always visible as soon as a video file is specified in the VideoStreamPlayer node. The node will no longer be resized to 0×0 by default, making the video invisible in the process (even if the audio can still be heard).
2022-07-05 22:43:09 +00:00
<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="false">
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>
Add loop property to VideoStreamPlayer
2023-06-04 23:14:19 +00:00
<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="false">
If [code]true[/code], the video restarts when it reaches its end.
</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.
Remove unused GDNative code This has been superseded by GDExtension so this code is no longer useful nor usable. There's still some GDNative-related stuff in platform export code which needs to be adapted for GDExtension (e.g. to include GDExtension libraries in exports).
2022-03-09 12:56:14 +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 GDExtension 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
</class>
Reference in New Issue Copy Permalink