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

78 lines
2.4 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" ?>
doc: Remove status from hardcoded version string It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 12:40:43 +00:00
<class name="VideoPlayer" inherits="Control" category="Core" version="3.1">
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>
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>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track">
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 [ci skip]
2017-09-13 06:49:40 +00:00
<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
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>
Update docs [ci skip]
2018-01-11 22:38:35 +00: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>
doc: Sync classref with current source
2017-11-15 19:35:18 +00:00
<member name="bus" type="String" setter="set_bus" getter="get_bus">
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="expand" type="bool" setter="set_expand" getter="has_expand">
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 [ci skip]
2017-09-13 06:49:40 +00:00
<member name="paused" type="bool" setter="set_paused" getter="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 [ci skip]
2017-09-13 06:49:40 +00:00
<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
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>
Update docs [ci skip]
2018-01-11 22:38:35 +00: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>
doc: Sync classref with current source [ci skip]
2017-09-13 06:49:40 +00:00
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_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>
<constants>
</constants>
</class>