1 /*****************************************************************************
\r
2 * axvlc.idl: ActiveX control for VLC
\r
3 *****************************************************************************
\r
4 * Copyright (C) 2006 the VideoLAN team
\r
6 * Authors: Damien Fouilleul <Damien.Fouilleul@laposte.net>
\r
7 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
\r
9 * This program is free software; you can redistribute it and/or modify
\r
10 * it under the terms of the GNU General Public License as published by
\r
11 * the Free Software Foundation; either version 2 of the License, or
\r
12 * (at your option) any later version.
\r
14 * This program is distributed in the hope that it will be useful,
\r
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
17 * GNU General Public License for more details.
\r
19 * You should have received a copy of the GNU General Public License
\r
20 * along with this program; if not, write to the Free Software
\r
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
\r
22 *****************************************************************************/
\r
24 //comments terminated by [t] are by tonsofpcs, regarding the string review. April 02, 2006. [t]
\r
25 //Possibly change all instances of "the current playlist" to "the playlist" and "current playlist" to "the playlist" [t]
\r
30 uuid(DF2BBE39-40A8-433b-A279-073F48DA94B6),
\r
32 helpstring("VideoLAN VLC ActiveX Plugin")
\r
36 // Forward declare all types defined in this typelib
\r
37 interface IVLCControl;
\r
38 interface IVLCAudio;
\r
39 interface IVLCInput;
\r
41 interface IVLCMessage;
\r
42 interface IVLCMessageIterator;
\r
43 interface IVLCMessages;
\r
44 interface IVLCPlaylist;
\r
45 interface IVLCVideo;
\r
46 interface IVLCControl2;
\r
47 dispinterface DVLCEvents;
\r
49 importlib("stdole2.tlb");
\r
51 typedef [public] enum VLCPlaylistMode
\r
53 VLCPlayListInsert = 1,
\r
54 VLCPlayListInsertAndGo = 9,
\r
55 VLCPlayListReplace = 2,
\r
56 VLCPlayListReplaceAndGo = 10,
\r
57 VLCPlayListAppend = 4,
\r
58 VLCPlayListAppendAndGo = 12,
\r
59 VLCPlayListCheckInsert = 16
\r
62 // playlist target position
\r
63 const int VLCPlayListEnd = -666;
\r
65 // DISPID definitions
\r
66 const int DISPID_BackColor = -501;
\r
68 const int DISPID_Visible = 100;
\r
69 const int DISPID_Playing = 101;
\r
70 const int DISPID_Position = 102;
\r
71 const int DISPID_Time = 103;
\r
72 const int DISPID_Length = 104;
\r
73 const int DISPID_Volume = 105;
\r
74 const int DISPID_MRL = 106;
\r
75 const int DISPID_AutoPlay = 107;
\r
76 const int DISPID_AutoLoop = 108;
\r
77 const int DISPID_StartTime = 109;
\r
78 const int DISPID_BaseURL = 110;
\r
79 const int DISPID_Toolbar = 111;
\r
83 uuid(C2FA41D0-B113-476e-AC8C-9BD14999C1C1),
\r
84 helpstring("VLC Control (deprecated)"),
\r
88 interface IVLCControl : IDispatch
\r
90 [id(DISPID_Visible), propget, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
\r
91 HRESULT Visible([out, retval] VARIANT_BOOL* visible);
\r
92 [id(DISPID_Visible), propput, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
\r
93 HRESULT Visible([in] VARIANT_BOOL visible);
\r
94 [helpstring("Play current target in playlist.")]
\r
96 [helpstring("Pause playback.")]
\r
98 [helpstring("Stop playback.")]
\r
100 [id(DISPID_Playing), hidden, propget, helpstring("Returns a value that determines whether VLC is currently playing.")]
\r
101 HRESULT Playing([out, retval] VARIANT_BOOL* isPlaying);
\r
102 [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
103 HRESULT Position([out, retval] float* position);
\r
104 [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
105 HRESULT Position([in] float position);
\r
106 [id(DISPID_Time), propget, helpstring("Returns/sets playback time relative to the start of the current item.")]
\r
107 HRESULT Time([out, retval] int* seconds);
\r
108 [id(DISPID_Time), propput, helpstring("Returns/sets playback time relative to the start of the current item.")]
\r
109 HRESULT Time([in] int seconds);
\r
110 [helpstring("Advance or backtrack playback time, relative to current time.")] //possibly find a better word to replace 'backtrack' [t]
\r
111 HRESULT shuttle([in] int seconds);
\r
112 [helpstring("Switch video between normal and fullscreen view modes.")]
\r
113 HRESULT fullscreen();
\r
114 [id(DISPID_Length), propget, hidden, helpstring("Returns the total length, in seconds, of the current item, may be unknown.")]
\r
115 HRESULT Length([out, retval] int* seconds);
\r
116 [helpstring("Increases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]
\r
117 HRESULT playFaster();
\r
118 [helpstring("Decreases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]
\r
119 HRESULT playSlower();
\r
120 [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
121 HRESULT Volume([out, retval] int* volume);
\r
122 [id(DISPID_Volume), propput, helpstring("Returns/sets playback volume, ranges from 0 to 200%.")]
\r
123 HRESULT Volume([in] int volume);
\r
124 [helpstring("Mute/unmute playback audio.")]
\r
125 HRESULT toggleMute();
\r
126 [helpstring("Sets the value of a VLC variable.")]
\r
127 HRESULT setVariable([in] BSTR name, [in] VARIANT value);
\r
128 [helpstring("Returns the value of a VLC variable.")]
\r
129 HRESULT getVariable([in] BSTR name, [out, retval] VARIANT *value);
\r
130 [helpstring("Add an item to the playlist.")]
\r
133 ** use VARIANT rather than a SAFEARRAY as argument type
\r
134 ** for compatibility with some scripting language (JScript)
\r
137 HRESULT addTarget([in] BSTR uri, [in] VARIANT options, [in] enum VLCPlaylistMode mode, [in] int position);
\r
138 [propget, helpstring("Returns index of current item in playlist.")]
\r
139 HRESULT PlaylistIndex([out, retval] int* index);
\r
140 [propget, helpstring("Returns number of items in playlist.")]
\r
141 HRESULT PlaylistCount([out, retval] int* index);
\r
142 [helpstring("Advance to next item in playlist.")]
\r
143 HRESULT playlistNext();
\r
144 [helpstring("Advance to previous item in playlist.")]
\r
145 HRESULT playlistPrev();
\r
146 [helpstring("Remove all items from playlist.")]
\r
147 HRESULT playlistClear();
\r
148 [propget, hidden, helpstring("Returns VLC Version.")]
\r
149 HRESULT VersionInfo([out, retval] BSTR* version);
\r
150 [id(DISPID_MRL), propget, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]
\r
151 HRESULT MRL([out, retval] BSTR* mrl);
\r
152 [id(DISPID_MRL), propput, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]
\r
153 HRESULT MRL([in] BSTR mrl);
\r
154 [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]
\r
155 HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);
\r
156 [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]
\r
157 HRESULT AutoPlay([in] VARIANT_BOOL autoplay);
\r
158 [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]
\r
159 HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);
\r
160 [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]
\r
161 HRESULT AutoLoop([in] VARIANT_BOOL autoloop);
\r
164 const int DISPID_PlayEvent = 100;
\r
165 const int DISPID_PauseEvent = 101;
\r
166 const int DISPID_StopEvent = 102;
\r
169 uuid(DF48072F-5EF8-434e-9B40-E2F3AE759B5F),
\r
170 helpstring("Event interface for VLC control"),
\r
172 dispinterface DVLCEvents
\r
176 [id(DISPID_PlayEvent), helpstring("Playing")]
\r
178 [id(DISPID_PauseEvent), helpstring("Paused")]
\r
180 [id(DISPID_StopEvent), helpstring("Stopped")]
\r
186 uuid(9E0BD17B-2D3C-4656-B94D-03084F3FD9D4),
\r
187 helpstring("VLC Audio APIs"),
\r
191 interface IVLCAudio : IDispatch
\r
193 [propget, helpstring("Returns/sets the audio mute state.")]
\r
194 HRESULT mute([out, retval] VARIANT_BOOL* muted);
\r
195 [propput, helpstring("Returns/sets the audio mute state.")]
\r
196 HRESULT mute([in] VARIANT_BOOL muted);
\r
198 [propget, helpstring("Returns/sets audio volume as a percent value.")]
\r
199 HRESULT volume([out, retval] long* volume);
\r
200 [propput, helpstring("Returns/sets audio volume as a percent value.")]
\r
201 HRESULT volume([in] long volume);
\r
203 [helpstring("Mute/unmute audio playback.")]
\r
204 HRESULT toggleMute();
\r
206 [propget, helpstring("Returns/sets audio track used/to use.")]
\r
207 HRESULT track([out, retval] long* track);
\r
208 [propput, helpstring("Returns/sets audio track used/to use.")]
\r
209 HRESULT track([in] long track);
\r
211 [propget, helpstring("Returns audio channel [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]
\r
212 HRESULT channel([out, retval] long* channel);
\r
213 [propput, helpstring("Sets audio channel to [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]
\r
214 HRESULT channel([in] long channel);
\r
219 uuid(49E0DBD1-9440-466C-9C97-95C67190C603),
\r
220 helpstring("VLC Input APIs"),
\r
224 interface IVLCInput : IDispatch
\r
226 [propget, helpstring("Returns the clip length, in milliseconds.")]
\r
227 HRESULT length([out, retval] double* length);
\r
229 [propget, helpstring("Returns/sets playback position in current clip. Position is ranging from 0.0 to 1.0.")]
\r
230 HRESULT position([out, retval] double* position);
\r
231 [propput, helpstring("Returns/sets playback position in the current clip. Position ranging from 0.0 to 1.0.")]
\r
232 HRESULT position([in] double position);
\r
234 [propget, helpstring("Returns/sets playback time in current clip, in milliseconds.")]
\r
235 HRESULT time([out, retval] double* time);
\r
236 [propput, helpstring("Returns/sets playback time in the current clip, in milliseconds.")]
\r
237 HRESULT time([in] double time);
\r
239 [propget, helpstring("Returns current playback state.")]
\r
240 HRESULT state([out, retval] long* state);
\r
242 [propget, helpstring("Returns/sets current playback rate, normal rate is 1.0 ")]
\r
243 HRESULT rate([out, retval] double* rate);
\r
244 [propput, helpstring("Returns/sets current playback rate, normal rate is 1.0.")]
\r
245 HRESULT rate([in] double rate);
\r
247 [propget, helpstring("Returns current playback frames per seconds if available.")]
\r
248 HRESULT fps([out, retval] double* fps);
\r
250 [propget, helpstring("Returns whether current playback displays video.")]
\r
251 HRESULT hasVout([out, retval] VARIANT_BOOL* hasVout);
\r
256 uuid(9ED00AFA-7BCD-4FFF-8D48-7DD4DB2C800D),
\r
257 helpstring("VLC Log Message"),
\r
261 interface IVLCMessage: IDispatch
\r
263 [id(DISPID_VALUE), propget]
\r
264 HRESULT _Value([out, retval] VARIANT* message);
\r
266 [propget, helpstring("Returns message severity.")]
\r
267 HRESULT severity([out, retval] long* level);
\r
269 [propget, helpstring("Returns message issuer type.")]
\r
270 HRESULT type([out, retval] BSTR* type);
\r
272 [propget, helpstring("Returns message issuer name.")]
\r
273 HRESULT name([out, retval] BSTR* name);
\r
275 [propget, helpstring("Returns message header.")]
\r
276 HRESULT header([out, retval] BSTR* header);
\r
278 [propget, helpstring("Returns message content.")]
\r
279 HRESULT message([out, retval] BSTR* message);
\r
284 uuid(15179CD8-CC12-4242-A58E-E412217FF343),
\r
285 helpstring("VLC Log iterator"),
\r
289 interface IVLCMessageIterator : IDispatch
\r
291 [propget, helpstring("Returns whether a message is available.")]
\r
292 HRESULT hasNext([out, retval] VARIANT_BOOL* hasNext);
\r
294 [helpstring("Returns next message.")]
\r
295 HRESULT next([out, retval] IVLCMessage** msg);
\r
300 uuid(6C5CE55D-2D6C-4AAD-8299-C62D2371F106),
\r
301 helpstring("VLC Log Messages Collection."),
\r
305 interface IVLCMessages : IDispatch
\r
307 [id(DISPID_NEWENUM), propget]
\r
308 HRESULT _NewEnum([out, retval] IUnknown** _NewEnum);
\r
310 [helpstring("Clear all messages from log.")]
\r
313 [propget, helpstring("Returns the number of messages.")]
\r
314 HRESULT count([out, retval] long* count);
\r
316 [helpstring("Returns an iterator for messages in log")]
\r
317 HRESULT iterator([out, retval] IVLCMessageIterator** iter);
\r
322 uuid(8E3BC3D9-62E9-48FB-8A6D-993F9ABC4A0A),
\r
323 helpstring("VLC Log APIs"),
\r
327 interface IVLCLog : IDispatch
\r
329 [propget, helpstring("Returns messages in log")]
\r
330 HRESULT messages([out, retval] IVLCMessages** iter);
\r
332 [propget, helpstring("Returns/Sets the log versbosity level.")]
\r
333 HRESULT verbosity([out, retval] long* level);
\r
334 [propput, helpstring("Returns/Sets the log versbosity level.")]
\r
335 HRESULT verbosity([in] long level);
\r
340 uuid(FD37FE32-82BC-4A25-B056-315F4DBB194D),
\r
341 helpstring("VLC Playlist Items collection"),
\r
345 interface IVLCPlaylistItems : IDispatch
\r
347 [propget, helpstring("Returns number of items in playlist.")]
\r
348 HRESULT count([out, retval] long* count);
\r
350 [helpstring("Remove all items from playlist.")]
\r
353 [helpstring("remove item from playlist.")]
\r
354 HRESULT remove([in] long itemId);
\r
359 uuid(54613049-40BF-4035-9E70-0A9312C0188D),
\r
360 helpstring("VLC Playlist APIs"),
\r
364 interface IVLCPlaylist : IDispatch
\r
366 [hidden, propget, helpstring("Returns number of items in playlist. (deprecated)")]
\r
367 HRESULT itemCount([out, retval] long* count);
\r
369 [propget, helpstring("Returns whether playback displays video.")]
\r
370 HRESULT isPlaying([out, retval] VARIANT_BOOL* playing);
\r
372 [helpstring("Add a playlist item.")]
\r
373 HRESULT add([in] BSTR uri, [in, optional] VARIANT name, [in, optional] VARIANT options, [out, retval] long* itemId);
\r
375 [helpstring("Play/Resume the playlist.")]
\r
378 [helpstring("Play item in playlist.")]
\r
379 HRESULT playItem([in] long itemId);
\r
381 [helpstring("Play/Pause current clip.")]
\r
382 HRESULT togglePause();
\r
384 [helpstring("Stop current clip.")]
\r
387 [helpstring("Advance to next item in playlist.")]
\r
390 [helpstring("Advance to previous item in playlist.")]
\r
393 [hidden, helpstring("Remove all items from playlist. (deprecated)")]
\r
396 [hidden, helpstring("Remove item from playlist. (deprecated)")]
\r
397 HRESULT removeItem([in] long item);
\r
399 [propget, helpstring("Returns the playlist items collection object.")]
\r
400 HRESULT items([out, retval] IVLCPlaylistItems** obj);
\r
405 uuid(0AAEDF0B-D333-4B27-A0C6-BBF31413A42E),
\r
406 helpstring("VLC Video APIs"),
\r
410 interface IVLCVideo : IDispatch
\r
412 [propget, helpstring("Returns/sets the fullscreen state.")]
\r
413 HRESULT fullscreen([out, retval] VARIANT_BOOL* fullscreen);
\r
415 [propput, helpstring("Returns/sets the fullscreen state.")]
\r
416 HRESULT fullscreen([in] VARIANT_BOOL fullscreen);
\r
418 [propget, helpstring("Returns video original width.")]
\r
419 HRESULT width([out, retval] long* width);
\r
421 [propget, helpstring("Returns video original height.")]
\r
422 HRESULT height([out, retval] long* height);
\r
424 [propget, helpstring("Returns video aspect ratio.")]
\r
425 HRESULT aspectRatio([out, retval] BSTR* aspect);
\r
426 [propput, helpstring("Sets video aspect ratio.")]
\r
427 HRESULT aspectRatio([in] BSTR aspect);
\r
429 [propget, helpstring("Returns video subtitle used.")]
\r
430 HRESULT subtitle([out, retval] long* spu);
\r
431 [propput, helpstring("Sets video subtitle to use.")]
\r
432 HRESULT subtitle([in] long spu);
\r
434 [propget, helpstring("Returns crop filter geometry.")]
\r
435 HRESULT crop([out, retval] BSTR* geometry);
\r
436 [propput, helpstring("Sets crop filter geometry.")]
\r
437 HRESULT crop([in] BSTR geometry);
\r
439 [propget, helpstring("Returns teletext page used.")]
\r
440 HRESULT teletext([out, retval] long* page);
\r
441 [propput, helpstring("Sets teletext page to use.")]
\r
442 HRESULT teletext([in] long page);
\r
444 [helpstring("toggle fullscreen/windowed state.")]
\r
445 HRESULT toggleFullscreen();
\r
447 [helpstring("take video snapshot and save it into picture object.")]
\r
448 HRESULT takeSnapshot([out, retval] IPictureDisp** picture);
\r
450 [helpstring("toggle teletext transparent state.")]
\r
451 HRESULT toggleTeletext();
\r
456 uuid(2D719729-5333-406C-BF12-8DE787FD65E3),
\r
457 helpstring("VLC Control"),
\r
461 interface IVLCControl2 : IDispatch
\r
463 [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]
\r
464 HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);
\r
465 [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]
\r
466 HRESULT AutoLoop([in] VARIANT_BOOL autoloop);
\r
468 [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]
\r
469 HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);
\r
470 [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]
\r
471 HRESULT AutoPlay([in] VARIANT_BOOL autoplay);
\r
473 [id(DISPID_BaseURL), propget, helpstring("Returns/sets the base URL for relative paths")]
\r
474 HRESULT BaseURL([out, retval] BSTR* url);
\r
475 [id(DISPID_BaseURL), propput, helpstring("Returns/sets the base URL for relative paths")]
\r
476 HRESULT BaseURL([in] BSTR url);
\r
478 [id(DISPID_StartTime), propget, helpstring("Returns/sets playback start time of URL.")]
\r
479 HRESULT StartTime([out, retval] long* seconds);
\r
480 [id(DISPID_StartTime), propput, helpstring("Returns/sets playback start time of URL.")]
\r
481 HRESULT StartTime([in] long seconds);
\r
483 [id(DISPID_MRL), propget, helpstring("Returns/sets the default MRL in playlist")]
\r
484 HRESULT MRL([out, retval] BSTR* mrl);
\r
485 [id(DISPID_MRL), propput, helpstring("Returns/sets the default MRL in playlist")]
\r
486 HRESULT MRL([in] BSTR mrl);
\r
488 [propget, helpstring("Returns VLC Version.")]
\r
489 HRESULT VersionInfo([out, retval] BSTR* version);
\r
491 [id(DISPID_Visible), propget, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
\r
492 HRESULT Visible([out, retval] VARIANT_BOOL* visible);
\r
493 [id(DISPID_Visible), propput, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
\r
494 HRESULT Visible([in] VARIANT_BOOL visible);
\r
496 [id(DISPID_Volume), propget, helpstring("Returns/sets default audio volume.")]
\r
497 HRESULT Volume([out, retval] long* volume);
\r
498 [id(DISPID_Volume), propput, helpstring("Returns/sets default audio volume.")]
\r
499 HRESULT Volume([in] long volume);
\r
501 [id(DISPID_BackColor), propget, helpstring("Returns/sets background color.")]
\r
502 HRESULT BackColor([out, retval] OLE_COLOR* backcolor);
\r
503 [id(DISPID_BackColor), propput, helpstring("Returns/sets background color.")]
\r
504 HRESULT BackColor([in] OLE_COLOR backcolor);
\r
507 * caution: vlcobject.toolbar:bool does not yet exists in Firefox
\r
508 * plugin. Official usage is through "toolbar" property for now,
\r
509 * which is compatibile with Firefox.
\r
511 [id(DISPID_Toolbar), propget, helpstring("Returns/sets visibility of the toolbar")]
\r
512 HRESULT Toolbar([out, retval] VARIANT_BOOL* visible);
\r
513 [id(DISPID_Toolbar), propput, helpstring("Returns/sets visibility of the toolbar")]
\r
514 HRESULT Toolbar([in] VARIANT_BOOL visible);
\r
516 [propget, helpstring("Returns the audio object.")]
\r
517 HRESULT audio([out, retval] IVLCAudio** obj);
\r
519 [propget, helpstring("Returns the audio object.")]
\r
520 HRESULT input([out, retval] IVLCInput** obj);
\r
522 [propget, helpstring("Returns the log object.")]
\r
523 HRESULT log([out, retval] IVLCLog** obj);
\r
525 [propget, helpstring("Returns the playlist object.")]
\r
526 HRESULT playlist([out, retval] IVLCPlaylist** obj);
\r
528 [propget, helpstring("Returns the audio object.")]
\r
529 HRESULT video([out, retval] IVLCVideo** obj);
\r
533 uuid(E23FE9C6-778E-49D4-B537-38FCDE4887D8),
\r
534 helpstring("VLC control (deprecated)"),
\r
539 [default] interface IVLCControl;
\r
540 interface IVLCControl2;
\r
541 [default, source] dispinterface DVLCEvents;
\r
545 uuid(9BE31822-FDAD-461B-AD51-BE1D1C159921),
\r
546 helpstring("VLC control"),
\r
551 [default] interface IVLCControl2;
\r
552 interface IVLCControl;
\r