b29ee0777d78fb541c159c35e07d906a6ee547dd
[vlc.git] / activex / axvlc.idl
1 /*****************************************************************************\r
2  * axvlc.idl: ActiveX control for VLC\r
3  *****************************************************************************\r
4  * Copyright (C) 2006 the VideoLAN team\r
5  *\r
6  * Authors: Damien Fouilleul <Damien.Fouilleul@laposte.net>\r
7  *\r
8  * This program is free software; you can redistribute it and/or modify\r
9  * it under the terms of the GNU General Public License as published by\r
10  * the Free Software Foundation; either version 2 of the License, or\r
11  * (at your option) any later version.\r
12  *\r
13  * This program is distributed in the hope that it will be useful,\r
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
16  * GNU General Public License for more details.\r
17  *\r
18  * You should have received a copy of the GNU General Public License\r
19  * along with this program; if not, write to the Free Software\r
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.\r
21  *****************************************************************************/\r
22 \r
23 //comments terminated by [t] are by tonsofpcs, regarding the string review.  April 02, 2006. [t]\r
24 //Possibly change all instances of "the current playlist" to "the playlist" and "current playlist" to "the playlist" [t]\r
25 \r
26 import "oaidl.idl";\r
27 \r
28 [\r
29   uuid(DF2BBE39-40A8-433b-A279-073F48DA94B6),\r
30   version(1.0),\r
31   helpstring("VideoLAN VLC ActiveX Plugin")\r
32 ]\r
33 library AXVLC\r
34 {\r
35     // Forward declare all types defined in this typelib\r
36     interface IVLCControl;\r
37     interface IVLCAudio;\r
38     interface IVLCInput;\r
39     interface IVLCPlaylist;\r
40     interface IVLCVideo;\r
41     interface IVLCControl2;\r
42     dispinterface DVLCEvents;\r
43 \r
44     importlib("stdole2.tlb");\r
45 \r
46     typedef [public] enum VLCPlaylistMode\r
47     {\r
48         VLCPlayListInsert       =  1,\r
49         VLCPlayListInsertAndGo  =  9,\r
50         VLCPlayListReplace      =  2,\r
51         VLCPlayListReplaceAndGo = 10,\r
52         VLCPlayListAppend       =  4,\r
53         VLCPlayListAppendAndGo  = 12,\r
54         VLCPlayListCheckInsert  = 16\r
55     } eVLCPlaylistMode;\r
56 \r
57     // playlist target position\r
58     const int VLCPlayListEnd    = -666;\r
59 \r
60     // DISPID definitions\r
61     const int DISPID_Visible    = 100;\r
62     const int DISPID_Playing    = 101;\r
63     const int DISPID_Position   = 102;\r
64     const int DISPID_Time       = 103;\r
65     const int DISPID_Length     = 104;\r
66     const int DISPID_Volume     = 105;\r
67     const int DISPID_MRL        = 106;\r
68     const int DISPID_AutoPlay   = 107;\r
69     const int DISPID_AutoLoop   = 108;\r
70     const int DISPID_StartTime  = 109;\r
71     const int DISPID_BaseURL    = 110;\r
72 \r
73     [\r
74       odl,\r
75       uuid(C2FA41D0-B113-476e-AC8C-9BD14999C1C1),\r
76       helpstring("VLC Control (deprecated)"),\r
77       dual,\r
78       hidden,\r
79       oleautomation\r
80     ]\r
81     interface IVLCControl : IDispatch\r
82     {\r
83         [id(DISPID_Visible), propget, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
84         HRESULT Visible([out, retval] VARIANT_BOOL* visible);\r
85         [id(DISPID_Visible), propput, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
86         HRESULT Visible([in] VARIANT_BOOL visible);\r
87         [helpstring("Play current target in playlist.")]\r
88         HRESULT play();\r
89         [helpstring("Pause playback.")]\r
90         HRESULT pause();\r
91         [helpstring("Stop playback.")]\r
92         HRESULT stop();\r
93         [id(DISPID_Playing), hidden, propget, helpstring("Returns a value that determines whether VLC is currently playing.")]\r
94         HRESULT Playing([out, retval] VARIANT_BOOL* isPlaying);\r
95         [id(DISPID_Position), propget, helpstring("Returns/sets playback position within the current item. Position is a relative value ranging from 0.0 to 1.0.")]\r
96         HRESULT Position([out, retval] float* position);\r
97         [id(DISPID_Position), propput, helpstring("Returns/sets playback position within the current item. Position is a relative value ranging from 0.0 to 1.0.")]\r
98         HRESULT Position([in] float position);\r
99         [id(DISPID_Time), propget, helpstring("Returns/sets playback time relative to the start of the current item.")]\r
100         HRESULT Time([out, retval] int* seconds);\r
101         [id(DISPID_Time), propput, helpstring("Returns/sets playback time relative to the start of the current item.")]\r
102         HRESULT Time([in] int seconds);\r
103         [helpstring("Advance or backtrack playback time, relative to current time.")]  //possibly find a better word to replace 'backtrack' [t]\r
104         HRESULT shuttle([in] int seconds);\r
105         [helpstring("Switch video between normal and fullscreen view modes.")]\r
106         HRESULT fullscreen();\r
107         [id(DISPID_Length), propget, hidden, helpstring("Returns the total length, in seconds, of the current item, may be unknown.")]\r
108         HRESULT Length([out, retval] int* seconds);\r
109         [helpstring("Increases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]\r
110         HRESULT playFaster();\r
111         [helpstring("Decreases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]\r
112         HRESULT playSlower();\r
113         [id(DISPID_Volume), propget, helpstring("Returns/sets playback volume, ranges from 0 to 200%.")]  //possibly remove % from 'ranges', change to 'values', and specify that 200 is equivilant to 200% (remember, 200% == 2.0, but this gets an int not a float) [t]\r
114         HRESULT Volume([out, retval] int* volume);\r
115         [id(DISPID_Volume), propput, helpstring("Returns/sets playback volume, ranges from 0 to 200%.")]\r
116         HRESULT Volume([in] int volume);\r
117         [helpstring("Mute/unmute playback audio.")]\r
118         HRESULT toggleMute();\r
119         [helpstring("Sets the value of a VLC variable.")]\r
120         HRESULT setVariable([in] BSTR name, [in] VARIANT value);\r
121         [helpstring("Returns the value of a VLC variable.")]\r
122         HRESULT getVariable([in] BSTR name, [out, retval] VARIANT *value);\r
123         [helpstring("Add an item to the playlist.")]\r
124 \r
125 /*\r
126 ** use VARIANT rather than a SAFEARRAY as argument type\r
127 ** for compatibility with some scripting language (JScript)\r
128 */\r
129 \r
130         HRESULT addTarget([in] BSTR uri, [in] VARIANT options, [in] enum VLCPlaylistMode mode, [in] int position);\r
131         [propget, helpstring("Returns index of current item in playlist.")]\r
132         HRESULT PlaylistIndex([out, retval] int* index);\r
133         [propget, helpstring("Returns number of items in playlist.")]\r
134         HRESULT PlaylistCount([out, retval] int* index);\r
135         [helpstring("Advance to next item in playlist.")]\r
136         HRESULT playlistNext();\r
137         [helpstring("Advance to previous item in playlist.")]\r
138         HRESULT playlistPrev();\r
139         [helpstring("Remove all items from playlist.")]\r
140         HRESULT playlistClear();\r
141         [propget, hidden, helpstring("Returns VLC Version.")]\r
142         HRESULT VersionInfo([out, retval] BSTR* version);\r
143         [id(DISPID_MRL), propget, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]\r
144         HRESULT MRL([out, retval] BSTR* mrl);\r
145         [id(DISPID_MRL), propput, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]\r
146         HRESULT MRL([in] BSTR mrl);\r
147         [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]\r
148         HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);\r
149         [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]\r
150         HRESULT AutoPlay([in] VARIANT_BOOL autoplay);\r
151         [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
152         HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);\r
153         [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
154         HRESULT AutoLoop([in] VARIANT_BOOL autoloop);\r
155     };\r
156 \r
157     const int DISPID_PlayEvent  = 100;\r
158     const int DISPID_PauseEvent = 101;\r
159     const int DISPID_StopEvent  = 102;\r
160 \r
161     [\r
162       uuid(DF48072F-5EF8-434e-9B40-E2F3AE759B5F),\r
163       helpstring("Event interface for VLC control"),\r
164       hidden\r
165     ]\r
166     dispinterface DVLCEvents\r
167     {\r
168         properties:\r
169         methods:\r
170             [id(DISPID_PlayEvent), helpstring("Playing")]\r
171             void play();\r
172             [id(DISPID_PauseEvent), helpstring("Paused")]\r
173             void pause();\r
174             [id(DISPID_StopEvent), helpstring("Stopped")]\r
175             void stop();\r
176     };\r
177 \r
178     [\r
179       odl,\r
180       uuid(9E0BD17B-2D3C-4656-B94D-03084F3FD9D4),\r
181       helpstring("VLC Audio APIs"),\r
182       hidden,\r
183       dual,\r
184       nonextensible,\r
185       oleautomation\r
186     ]\r
187     interface IVLCAudio : IDispatch\r
188     {\r
189         [propget, helpstring("Returns/sets the audio mute state.")]\r
190         HRESULT mute([out, retval] VARIANT_BOOL* muted);\r
191         [propput, helpstring("Returns/sets the audio mute state.")]\r
192         HRESULT mute([in] VARIANT_BOOL muted);\r
193 \r
194         [propget, helpstring("Returns/sets audio volume as a percent value.")]\r
195         HRESULT volume([out, retval] int* volume);\r
196         [propput, helpstring("Returns/sets audio volume as a percent value.")]\r
197         HRESULT volume([in] int volume);\r
198 \r
199         [helpstring("Mute/unmute audio playback.")]\r
200         HRESULT toggleMute();\r
201     };\r
202 \r
203     [\r
204       odl,\r
205       uuid(49E0DBD1-9440-466C-9C97-95C67190C603),\r
206       helpstring("VLC Input APIs"),\r
207       hidden,\r
208       dual,\r
209       nonextensible,\r
210       oleautomation\r
211     ]\r
212     interface IVLCInput : IDispatch\r
213     {\r
214         [propget, helpstring("Returns the clip length, in milliseconds.")]\r
215         HRESULT length([out, retval] double* length);\r
216 \r
217         [propget, helpstring("Returns/sets playback position in current clip.  Position is ranging from 0.0 to 1.0.")]\r
218         HRESULT position([out, retval] float* position);\r
219         [propput, helpstring("Returns/sets playback position in the current clip.  Position ranging from 0.0 to 1.0.")]\r
220         HRESULT position([in] float position);\r
221 \r
222         [propget, helpstring("Returns/sets playback time in current clip, in milliseconds.")]\r
223         HRESULT time([out, retval] double* time);\r
224         [propput, helpstring("Returns/sets playback time in the current clip, in milliseconds.")]\r
225         HRESULT time([in] double time);\r
226 \r
227         [propget, helpstring("Returns current playback state.")]\r
228         HRESULT state([out, retval] int* state);\r
229 \r
230         [propget, helpstring("Returns/sets current playback rate, normal rate is 1.0 ")]\r
231         HRESULT rate([out, retval] float* rate);\r
232         [propput, helpstring("Returns/sets current playback rate, normal rate is 1.0.")]\r
233         HRESULT rate([in] float rate);\r
234 \r
235         [propget, helpstring("Returns current playback frames per seconds if available.")]\r
236         HRESULT fps([out, retval] float* fps);\r
237 \r
238         [propget, helpstring("Returns whether current playback displays video.")]\r
239         HRESULT hasVout([out, retval] VARIANT_BOOL* hasVout);\r
240     };\r
241 \r
242     [\r
243       odl,\r
244       uuid(54613049-40BF-4035-9E70-0A9312C0188D),\r
245       helpstring("VLC Playlist APIs"),\r
246       hidden,\r
247       dual,\r
248       nonextensible,\r
249       oleautomation\r
250     ]\r
251     interface IVLCPlaylist : IDispatch\r
252     {\r
253         [propget, helpstring("Returns number of items in playlist.")]\r
254         HRESULT itemCount([out, retval] int* count);\r
255 \r
256         [propget, helpstring("Returns whether playback displays video.")]\r
257         HRESULT isPlaying([out, retval] VARIANT_BOOL* playing);\r
258 \r
259         [helpstring("Add a playlist item.")]\r
260         HRESULT add([in] BSTR uri, [in, optional] VARIANT name, [in, optional] VARIANT options, [out, retval] int* item);\r
261 \r
262         [helpstring("Play/Resume the playlist.")]\r
263         HRESULT play();\r
264 \r
265         [helpstring("Play item in playlist.")]\r
266         HRESULT playItem([in] int item);\r
267 \r
268         [helpstring("Play/Pause current clip.")]\r
269         HRESULT togglePause();\r
270 \r
271         [helpstring("Stop current clip.")]\r
272         HRESULT stop();\r
273 \r
274         [helpstring("Advance to next item in playlist.")]\r
275         HRESULT next();\r
276 \r
277         [helpstring("Advance to previous item in playlist.")]\r
278         HRESULT prev();\r
279 \r
280         [helpstring("Remove all items from playlist.")]\r
281         HRESULT clear();\r
282 \r
283         [helpstring("remove item from playlist.")]\r
284         HRESULT removeItem([in] int item);\r
285     };\r
286 \r
287     [\r
288       odl,\r
289       uuid(0AAEDF0B-D333-4B27-A0C6-BBF31413A42E),\r
290       helpstring("VLC Video APIs"),\r
291       hidden,\r
292       dual,\r
293       nonextensible,\r
294       oleautomation\r
295     ]\r
296     interface IVLCVideo : IDispatch\r
297     {\r
298         [propget, helpstring("Returns/sets the fullscreen state.")]\r
299         HRESULT fullscreen([out, retval] VARIANT_BOOL* fullscreen);\r
300         [propput, helpstring("Returns/sets the fullscreen state.")]\r
301         HRESULT fullscreen([in] VARIANT_BOOL fullscreen);\r
302 \r
303         [propget, helpstring("Returns video original width.")]\r
304         HRESULT width([out, retval] int* width);\r
305 \r
306         [propget, helpstring("Returns video original height.")]\r
307         HRESULT height([out, retval] int* height);\r
308 \r
309         [helpstring("toggle fullscreen/windowed state.")]\r
310         HRESULT toggleFullscreen();\r
311     };\r
312 \r
313     [\r
314       odl,\r
315       uuid(2D719729-5333-406C-BF12-8DE787FD65E3),\r
316       helpstring("VLC Control"),\r
317       hidden,\r
318       dual,\r
319       oleautomation\r
320     ]\r
321     interface IVLCControl2 : IDispatch\r
322     {\r
323         [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
324         HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);\r
325         [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
326         HRESULT AutoLoop([in] VARIANT_BOOL autoloop);\r
327 \r
328         [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]\r
329         HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);\r
330         [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]\r
331         HRESULT AutoPlay([in] VARIANT_BOOL autoplay);\r
332 \r
333         [id(DISPID_BaseURL), propget, helpstring("Returns/sets the base URL for relative paths")]\r
334         HRESULT BaseURL([out, retval] BSTR* url);\r
335         [id(DISPID_BaseURL), propput, helpstring("Returns/sets the base URL for relative paths")]\r
336         HRESULT BaseURL([in] BSTR url);\r
337 \r
338         [id(DISPID_StartTime), propget, helpstring("Returns/sets playback start time of URL.")]\r
339         HRESULT StartTime([out, retval] int* seconds);\r
340         [id(DISPID_StartTime), propput, helpstring("Returns/sets playback start time of URL.")]\r
341         HRESULT StartTime([in] int seconds);\r
342 \r
343         [id(DISPID_MRL), propget, helpstring("Returns/sets the default MRL in playlist")]\r
344         HRESULT MRL([out, retval] BSTR* mrl);\r
345         [id(DISPID_MRL), propput, helpstring("Returns/sets the default MRL in playlist")]\r
346         HRESULT MRL([in] BSTR mrl);\r
347 \r
348         [propget, helpstring("Returns VLC Version.")]\r
349         HRESULT VersionInfo([out, retval] BSTR* version);\r
350 \r
351         [id(DISPID_Visible), propget, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
352         HRESULT Visible([out, retval] VARIANT_BOOL* visible);\r
353         [id(DISPID_Visible), propput, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
354         HRESULT Visible([in] VARIANT_BOOL visible);\r
355 \r
356         [id(DISPID_Volume), propget, helpstring("Returns/sets default audio volume.")]\r
357         HRESULT Volume([out, retval] int* volume);\r
358         [id(DISPID_Volume), propput, helpstring("Returns/sets default audio volume.")]\r
359         HRESULT Volume([in] int volume);\r
360 \r
361         [propget, helpstring("Returns the audio object.")]\r
362         HRESULT audio([out, retval] IVLCAudio** obj);\r
363 \r
364         [propget, helpstring("Returns the audio object.")]\r
365         HRESULT input([out, retval] IVLCInput** obj);\r
366 \r
367         [propget, helpstring("Returns the playlist object.")]\r
368         HRESULT playlist([out, retval] IVLCPlaylist** obj);\r
369 \r
370         [propget, helpstring("Returns the audio object.")]\r
371         HRESULT video([out, retval] IVLCVideo** obj);\r
372     };\r
373 \r
374     [\r
375       uuid(E23FE9C6-778E-49D4-B537-38FCDE4887D8),\r
376       helpstring("VLC control (deprecated)"),\r
377       control\r
378     ]\r
379     coclass VLCPlugin\r
380     {\r
381         [default] interface IVLCControl;\r
382         interface IVLCControl2;\r
383         [default, source] dispinterface DVLCEvents;\r
384     };\r
385 \r
386     [\r
387       uuid(9BE31822-FDAD-461B-AD51-BE1D1C159921),\r
388       helpstring("VLC control"),\r
389       control\r
390     ]\r
391     coclass VLCPlugin2\r
392     {\r
393         [default] interface IVLCControl2;\r
394         interface IVLCControl;\r
395         [default, source] dispinterface DVLCEvents;\r
396     };\r
397 };\r