virtualx-engine/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 WebM and OGV Theora.
	</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">
			<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">
			The embedded audio track to play.
		</member>
		<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
			If [code]true[/code], playback starts when the scene loads. Default value: [code]false[/code].
		</member>
		<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec">
			Amount of time in milliseconds to store in buffer while playing.
		</member>
		<member name="bus" type="String" setter="set_bus" getter="get_bus">
			Audio bus to use for sound playback.
		</member>
		<member name="expand" type="bool" setter="set_expand" getter="has_expand">
			If [code]true[/code], the video scales to the control size. Default value: [code]true[/code].
		</member>
		<member name="paused" type="bool" setter="set_paused" getter="is_paused">
			If [code]true[/code], the video is paused.
		</member>
		<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
		</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">
			Audio volume in dB.
		</member>
	</members>
	<signals>
		<signal name="finished">
			<description>
				Emitted when playback is finished.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>