2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-19 10:46:33 +01:00
<class name= "VideoPlayer" inherits= "Control" category= "Core" version= "3.1-dev" >
2017-09-12 22:42:36 +02:00
<brief_description >
Control to play video files.
</brief_description>
<description >
This control has the ability to play video streams. The only format accepted is the OGV Theora, so any other format must be converted before using in a project.
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_stream_name" qualifiers= "const" >
<return type= "String" >
</return>
<description >
Get the name of the video stream.
</description>
</method>
<method name= "get_video_texture" >
<return type= "Texture" >
</return>
<description >
Get the current frame of the video as a [Texture].
</description>
</method>
<method name= "is_playing" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
Get whether or not the video is playing.
</description>
</method>
<method name= "play" >
<return type= "void" >
</return>
<description >
Start the video playback.
</description>
</method>
<method name= "stop" >
<return type= "void" >
</return>
<description >
Stop the video playback.
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "audio_track" type= "int" setter= "set_audio_track" getter= "get_audio_track" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "autoplay" type= "bool" setter= "set_autoplay" getter= "has_autoplay" >
2017-09-12 22:42:36 +02:00
</member>
2018-01-11 23:38:35 +01:00
<member name= "buffering_msec" type= "int" setter= "set_buffering_msec" getter= "get_buffering_msec" >
The amount of milliseconds to store in buffer while playing.
</member>
2017-11-15 20:35:18 +01:00
<member name= "bus" type= "String" setter= "set_bus" getter= "get_bus" >
</member>
2017-09-13 08:49:40 +02:00
<member name= "expand" type= "bool" setter= "set_expand" getter= "has_expand" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "paused" type= "bool" setter= "set_paused" getter= "is_paused" >
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "stream" type= "VideoStream" setter= "set_stream" getter= "get_stream" >
2017-09-12 22:42:36 +02:00
</member>
2018-01-11 23:38:35 +01:00
<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" >
The volume of the audio track as a linear value.
</member>
2017-09-13 08:49:40 +02:00
<member name= "volume_db" type= "float" setter= "set_volume_db" getter= "get_volume_db" >
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>