blob: 281dc1f0714fa1fca588d620dc0ed6ab0ece647c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VideoPlayer" inherits="Control" category="Core" version="3.0-beta">
<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_buffering_msec" qualifiers="const">
<return type="int">
</return>
<description>
Get the amount of milliseconds to store in buffer while playing.
</description>
</method>
<method name="get_stream_name" qualifiers="const">
<return type="String">
</return>
<description>
Get the name of the video stream.
</description>
</method>
<method name="get_stream_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the current position of the stream, in seconds.
</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="get_volume" qualifiers="const">
<return type="float">
</return>
<description>
Get the volume of the audio track as a linear value.
</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="set_buffering_msec">
<return type="void">
</return>
<argument index="0" name="msec" type="int">
</argument>
<description>
Set the amount of milliseconds to buffer during playback.
</description>
</method>
<method name="set_stream_position">
<return type="void">
</return>
<argument index="0" name="position" type="float">
</argument>
<description>
Set the current position of the stream, in seconds.
</description>
</method>
<method name="set_volume">
<return type="void">
</return>
<argument index="0" name="volume" type="float">
</argument>
<description>
Set the audio volume as a linear value.
</description>
</method>
<method name="stop">
<return type="void">
</return>
<description>
Stop the video playback.
</description>
</method>
</methods>
<members>
<member name="audio_track" type="int" setter="set_audio_track" getter="get_audio_track">
</member>
<member name="autoplay" type="bool" setter="set_autoplay" getter="has_autoplay">
</member>
<member name="bus" type="String" setter="set_bus" getter="get_bus">
</member>
<member name="expand" type="bool" setter="set_expand" getter="has_expand">
</member>
<member name="paused" type="bool" setter="set_paused" getter="is_paused">
</member>
<member name="stream" type="VideoStream" setter="set_stream" getter="get_stream">
</member>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
</member>
</members>
<constants>
</constants>
</class>
|