godot/doc/classes/VideoPlayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoPlayer" inherits="Control" category="Core" version="3.2">
	<brief_description>
		Control for playing video streams.
	</brief_description>
	<description>
		Control node for playing video streams. Supported formats are [url=https://www.webmproject.org/]WebM[/url] and [url=https://www.theora.org/]Ogg Theora[/url].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_stream_name" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the video stream's name.
			</description>
		</method>
		<method name="get_video_texture" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
				Returns the current frame as a [Texture].
			</description>
		</method>
		<method name="is_playing" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the video is playing.
			</description>
		</method>
		<method name="play">
			<return type="void">
			</return>
			<description>
				Starts the video playback.
			</description>
		</method>
		<method name="stop">
			<return type="void">
			</return>
			<description>
				Stops the video playback.
			</description>
		</method>
	</methods>
	<members>
		<member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track" default="0">
			The embedded audio track to play.
		</member>
		<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay" default="false">
			If [code]true[/code], playback starts when the scene loads.
		</member>
		<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec" default="500">
			Amount of time in milliseconds to store in buffer while playing.
		</member>
		<member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
			Audio bus to use for sound playback.
		</member>
		<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">
			If [code]true[/code], the video scales to the control size.
		</member>
		<member name="paused" type="bool" setter="set_paused" getter="is_paused" default="false">
			If [code]true[/code], the video is paused.
		</member>
		<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
			The assigned video stream. See description for supported formats.
		</member>
		<member name="stream_position" type="float" setter="set_stream_position" getter="get_stream_position">
			The current position of the stream, in seconds.
		</member>
		<member name="volume" type="float" setter="set_volume" getter="get_volume">
			Audio volume as a linear value.
		</member>
		<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
			Audio volume in dB.
		</member>
	</members>
	<signals>
		<signal name="finished">
			<description>
				Emitted when playback is finished.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>
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" ?>`
doc: Bump version to 3.2 2019-04-01 10:33:56 +00:00			`<class name="VideoPlayer" inherits="Control" category="Core" version="3.2">`
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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`Control node for playing video streams. Supported formats are [url=https://www.webmproject.org/]WebM[/url] and [url=https://www.theora.org/]Ogg Theora[/url].`
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">`
			`<return type="String">`
			`</return>`
			`<description>`
[DOCS] Update VideoPlayer classref 2018-05-20 20:43:48 +00:00			`Returns the video stream's name.`
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">`
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			`<return type="Texture">`
			`</return>`
			`<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">`
			`<return type="bool">`
			`</return>`
			`<description>`
[DOCS] Update VideoPlayer classref 2018-05-20 20:43:48 +00:00			`Returns [code]true[/code] if the video is playing.`
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">`
			`<return type="void">`
			`</return>`
			`<description>`
[DOCS] Update VideoPlayer classref 2018-05-20 20:43:48 +00:00			`Starts the 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			`</description>`
			`</method>`
			`<method name="stop">`
			`<return type="void">`
			`</return>`
			`<description>`
[DOCS] Update VideoPlayer classref 2018-05-20 20:43:48 +00:00			`Stops the 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			`</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=""Master"">`
[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: 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], the video scales to the control size.`
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.`
			`</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>`