git.sesse.net Git - vlc/blob - projects/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  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>\r
   8  *\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
  13  *\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
  18  *\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
  23 \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
  26 \r
  27 import "ocidl.idl";\r
  28 \r
  29 [\r
  30   uuid(DF2BBE39-40A8-433b-A279-073F48DA94B6),\r
  31   version(1.0),\r
  32   helpstring("VideoLAN VLC ActiveX Plugin")\r
  33 ]\r
  34 library AXVLC\r
  35 {\r
  36     // Forward declare all types defined in this typelib\r
  37     interface IVLCControl;\r
  38     interface IVLCAudio;\r
  39     interface IVLCInput;\r
  40     interface IVLCLog;\r
  41     interface IVLCMarquee;\r
  42     interface IVLCMessage;\r
  43     interface IVLCMessageIterator;\r
  44     interface IVLCMessages;\r
  45     interface IVLCPlaylist;\r
  46     interface IVLCSubtitle;\r
  47     interface IVLCVideo;\r
  48     interface IVLCControl2;\r
  49     dispinterface DVLCEvents;\r
  50 \r
  51     importlib("stdole2.tlb");\r
  52 \r
  53     typedef [public] enum VLCPlaylistMode\r
  54     {\r
  55         VLCPlayListInsert       =  1,\r
  56         VLCPlayListInsertAndGo  =  9,\r
  57         VLCPlayListReplace      =  2,\r
  58         VLCPlayListReplaceAndGo = 10,\r
  59         VLCPlayListAppend       =  4,\r
  60         VLCPlayListAppendAndGo  = 12,\r
  61         VLCPlayListCheckInsert  = 16\r
  62     } eVLCPlaylistMode;\r
  63 \r
  64     // playlist target position\r
  65     const int VLCPlayListEnd    = -666;\r
  66 \r
  67     // DISPID definitions\r
  68     const int DISPID_BackColor  = -501;\r
  69 \r
  70     const int DISPID_Visible    = 100;\r
  71     const int DISPID_Playing    = 101;\r
  72     const int DISPID_Position   = 102;\r
  73     const int DISPID_Time       = 103;\r
  74     const int DISPID_Length     = 104;\r
  75     const int DISPID_Volume     = 105;\r
  76     const int DISPID_MRL        = 106;\r
  77     const int DISPID_AutoPlay   = 107;\r
  78     const int DISPID_AutoLoop   = 108;\r
  79     const int DISPID_StartTime  = 109;\r
  80     const int DISPID_BaseURL    = 110;\r
  81     const int DISPID_Toolbar     = 111;\r
  82 \r
  83     [\r
  84       odl,\r
  85       uuid(C2FA41D0-B113-476e-AC8C-9BD14999C1C1),\r
  86       helpstring("VLC Control (deprecated)"),\r
  87       dual,\r
  88       oleautomation\r
  89     ]\r
  90     interface IVLCControl : IDispatch\r
  91     {\r
  92         [id(DISPID_Visible), propget, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
  93         HRESULT Visible([out, retval] VARIANT_BOOL* visible);\r
  94         [id(DISPID_Visible), propput, bindable, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
  95         HRESULT Visible([in] VARIANT_BOOL visible);\r
  96         [helpstring("Play current target in playlist.")]\r
  97         HRESULT play();\r
  98         [helpstring("Pause playback.")]\r
  99         HRESULT pause();\r
 100         [helpstring("Stop playback.")]\r
 101         HRESULT stop();\r
 102         [id(DISPID_Playing), hidden, propget, helpstring("Returns a value that determines whether VLC is currently playing.")]\r
 103         HRESULT Playing([out, retval] VARIANT_BOOL* isPlaying);\r
 104         [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
 105         HRESULT Position([out, retval] float* position);\r
 106         [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
 107         HRESULT Position([in] float position);\r
 108         [id(DISPID_Time), propget, helpstring("Returns/sets playback time relative to the start of the current item.")]\r
 109         HRESULT Time([out, retval] int* seconds);\r
 110         [id(DISPID_Time), propput, helpstring("Returns/sets playback time relative to the start of the current item.")]\r
 111         HRESULT Time([in] int seconds);\r
 112         [helpstring("Advance or backtrack playback time, relative to current time.")]  //possibly find a better word to replace 'backtrack' [t]\r
 113         HRESULT shuttle([in] int seconds);\r
 114         [helpstring("Switch video between normal and fullscreen view modes.")]\r
 115         HRESULT fullscreen();\r
 116         [id(DISPID_Length), propget, hidden, helpstring("Returns the total length, in seconds, of the current item, may be unknown.")]\r
 117         HRESULT Length([out, retval] int* seconds);\r
 118         [helpstring("Increases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]\r
 119         HRESULT playFaster();\r
 120         [helpstring("Decreases playback speed. Possible speeds are: 1x, 2x, 4x, 8x.")]\r
 121         HRESULT playSlower();\r
 122         [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
 123         HRESULT Volume([out, retval] int* volume);\r
 124         [id(DISPID_Volume), propput, helpstring("Returns/sets playback volume, ranges from 0 to 200%.")]\r
 125         HRESULT Volume([in] int volume);\r
 126         [helpstring("Mute/unmute playback audio.")]\r
 127         HRESULT toggleMute();\r
 128         [helpstring("Sets the value of a VLC variable.")]\r
 129         HRESULT setVariable([in] BSTR name, [in] VARIANT value);\r
 130         [helpstring("Returns the value of a VLC variable.")]\r
 131         HRESULT getVariable([in] BSTR name, [out, retval] VARIANT *value);\r
 132         [helpstring("Add an item to the playlist.")]\r
 133 \r
 134 /*\r
 135 ** use VARIANT rather than a SAFEARRAY as argument type\r
 136 ** for compatibility with some scripting language (JScript)\r
 137 */\r
 138 \r
 139         HRESULT addTarget([in] BSTR uri, [in] VARIANT options, [in] enum VLCPlaylistMode mode, [in] int position);\r
 140         [propget, helpstring("Returns index of current item in playlist.")]\r
 141         HRESULT PlaylistIndex([out, retval] int* index);\r
 142         [propget, helpstring("Returns number of items in playlist.")]\r
 143         HRESULT PlaylistCount([out, retval] int* index);\r
 144         [helpstring("Advance to next item in playlist.")]\r
 145         HRESULT playlistNext();\r
 146         [helpstring("Advance to previous item in playlist.")]\r
 147         HRESULT playlistPrev();\r
 148         [helpstring("Remove all items from playlist.")]\r
 149         HRESULT playlistClear();\r
 150         [propget, hidden, helpstring("Returns VLC Version.")]\r
 151         HRESULT VersionInfo([out, retval] BSTR* version);\r
 152         [id(DISPID_MRL), propget, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]\r
 153         HRESULT MRL([out, retval] BSTR* mrl);\r
 154         [id(DISPID_MRL), propput, helpstring("Returns/sets the first MRL in playlist, used for AutoPlay")]\r
 155         HRESULT MRL([in] BSTR mrl);\r
 156         [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]\r
 157         HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);\r
 158         [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]\r
 159         HRESULT AutoPlay([in] VARIANT_BOOL autoplay);\r
 160         [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
 161         HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);\r
 162         [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
 163         HRESULT AutoLoop([in] VARIANT_BOOL autoloop);\r
 164     };\r
 165 \r
 166     const int DISPID_PlayEvent  = 100;\r
 167     const int DISPID_PauseEvent = 101;\r
 168     const int DISPID_StopEvent  = 102;\r
 169 \r
 170     [\r
 171       uuid(DF48072F-5EF8-434e-9B40-E2F3AE759B5F),\r
 172       helpstring("Event interface for VLC control"),\r
 173     ]\r
 174     dispinterface DVLCEvents\r
 175     {\r
 176         properties:\r
 177         methods:\r
 178             [id(DISPID_PlayEvent), helpstring("Playing")]\r
 179             void play();\r
 180             [id(DISPID_PauseEvent), helpstring("Paused")]\r
 181             void pause();\r
 182             [id(DISPID_StopEvent), helpstring("Stopped")]\r
 183             void stop();\r
 184     };\r
 185 \r
 186     [\r
 187       odl,\r
 188       uuid(9E0BD17B-2D3C-4656-B94D-03084F3FD9D4),\r
 189       helpstring("VLC Audio APIs"),\r
 190       dual,\r
 191       oleautomation\r
 192     ]\r
 193     interface IVLCAudio : IDispatch\r
 194     {\r
 195         [propget, helpstring("Returns/sets the audio mute state.")]\r
 196         HRESULT mute([out, retval] VARIANT_BOOL* muted);\r
 197         [propput, helpstring("Returns/sets the audio mute state.")]\r
 198         HRESULT mute([in] VARIANT_BOOL muted);\r
 199 \r
 200         [propget, helpstring("Returns/sets audio volume as a percent value.")]\r
 201         HRESULT volume([out, retval] long* volume);\r
 202         [propput, helpstring("Returns/sets audio volume as a percent value.")]\r
 203         HRESULT volume([in] long volume);\r
 204 \r
 205         [helpstring("Mute/unmute audio playback.")]\r
 206         HRESULT toggleMute();\r
 207 \r
 208         [propget, helpstring("Returns/sets audio track used/to use.")]\r
 209         HRESULT track([out, retval] long* track);\r
 210         [propput, helpstring("Returns/sets audio track used/to use.")]\r
 211         HRESULT track([in] long track);\r
 212 \r
 213         [propget, helpstring("Returns the number of audio tracks available.")]\r
 214         HRESULT count([out, retval] long* trackNumber);\r
 215         [helpstring("Returns audio track name.")]\r
 216         HRESULT description([in] long trackID, [out, retval] BSTR* name);\r
 217 \r
 218         [propget, helpstring("Returns audio channel [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]\r
 219         HRESULT channel([out, retval] long* channel);\r
 220         [propput, helpstring("Sets audio channel to [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]\r
 221         HRESULT channel([in] long channel);\r
 222     };\r
 223 \r
 224     [\r
 225       odl,\r
 226       uuid(49E0DBD1-9440-466C-9C97-95C67190C603),\r
 227       helpstring("VLC Input APIs"),\r
 228       dual,\r
 229       oleautomation\r
 230     ]\r
 231     interface IVLCInput : IDispatch\r
 232     {\r
 233         [propget, helpstring("Returns the clip length, in milliseconds.")]\r
 234         HRESULT length([out, retval] double* length);\r
 235 \r
 236         [propget, helpstring("Returns/sets playback position in current clip.  Position is ranging from 0.0 to 1.0.")]\r
 237         HRESULT position([out, retval] double* position);\r
 238         [propput, helpstring("Returns/sets playback position in the current clip.  Position ranging from 0.0 to 1.0.")]\r
 239         HRESULT position([in] double position);\r
 240 \r
 241         [propget, helpstring("Returns/sets playback time in current clip, in milliseconds.")]\r
 242         HRESULT time([out, retval] double* time);\r
 243         [propput, helpstring("Returns/sets playback time in the current clip, in milliseconds.")]\r
 244         HRESULT time([in] double time);\r
 245 \r
 246         [propget, helpstring("Returns current playback state.")]\r
 247         HRESULT state([out, retval] long* state);\r
 248 \r
 249         [propget, helpstring("Returns/sets current playback rate, normal rate is 1.0 ")]\r
 250         HRESULT rate([out, retval] double* rate);\r
 251         [propput, helpstring("Returns/sets current playback rate, normal rate is 1.0.")]\r
 252         HRESULT rate([in] double rate);\r
 253 \r
 254         [propget, helpstring("Returns current playback frames per seconds if available.")]\r
 255         HRESULT fps([out, retval] double* fps);\r
 256 \r
 257         [propget, helpstring("Returns whether current playback displays video.")]\r
 258         HRESULT hasVout([out, retval] VARIANT_BOOL* hasVout);\r
 259     };\r
 260 \r
 261     [\r
 262       odl,\r
 263       uuid(9ED00AFA-7BCD-4FFF-8D48-7DD4DB2C800D),\r
 264       helpstring("VLC Log Message"),\r
 265       dual,\r
 266       oleautomation\r
 267     ]\r
 268     interface IVLCMessage: IDispatch\r
 269     {\r
 270         [id(DISPID_VALUE), propget]\r
 271         HRESULT _Value([out, retval] VARIANT* message);\r
 272 \r
 273         [propget, helpstring("Returns message severity.")]\r
 274         HRESULT severity([out, retval] long* level);\r
 275 \r
 276         [propget, helpstring("Returns message issuer type.")]\r
 277         HRESULT type([out, retval] BSTR* type);\r
 278 \r
 279         [propget, helpstring("Returns message issuer name.")]\r
 280         HRESULT name([out, retval] BSTR* name);\r
 281 \r
 282         [propget, helpstring("Returns message header.")]\r
 283         HRESULT header([out, retval] BSTR* header);\r
 284 \r
 285         [propget, helpstring("Returns message content.")]\r
 286         HRESULT message([out, retval] BSTR* message);\r
 287     };\r
 288 \r
 289     [\r
 290       odl,\r
 291       uuid(15179CD8-CC12-4242-A58E-E412217FF343),\r
 292       helpstring("VLC Log iterator"),\r
 293       dual,\r
 294       oleautomation\r
 295     ]\r
 296     interface IVLCMessageIterator : IDispatch\r
 297     {\r
 298         [propget, helpstring("Returns whether a message is available.")]\r
 299         HRESULT hasNext([out, retval] VARIANT_BOOL* hasNext);\r
 300 \r
 301         [helpstring("Returns next message.")]\r
 302         HRESULT next([out, retval] IVLCMessage** msg);\r
 303     };\r
 304 \r
 305     [\r
 306       odl,\r
 307       uuid(6C5CE55D-2D6C-4AAD-8299-C62D2371F106),\r
 308       helpstring("VLC Log Messages Collection."),\r
 309       dual,\r
 310       oleautomation\r
 311     ]\r
 312     interface IVLCMessages : IDispatch\r
 313     {\r
 314         [id(DISPID_NEWENUM), propget]\r
 315         HRESULT _NewEnum([out, retval] IUnknown** _NewEnum);\r
 316 \r
 317         [helpstring("Clear all messages from log.")]\r
 318         HRESULT clear();\r
 319 \r
 320         [propget, helpstring("Returns the number of messages.")]\r
 321         HRESULT count([out, retval] long* count);\r
 322 \r
 323         [helpstring("Returns an iterator for messages in log")]\r
 324         HRESULT iterator([out, retval] IVLCMessageIterator** iter);\r
 325     };\r
 326 \r
 327     [\r
 328       odl,\r
 329       uuid(8E3BC3D9-62E9-48FB-8A6D-993F9ABC4A0A),\r
 330       helpstring("VLC Log APIs"),\r
 331       dual,\r
 332       oleautomation\r
 333     ]\r
 334     interface IVLCLog : IDispatch\r
 335     {\r
 336         [propget, helpstring("Returns messages in log")]\r
 337         HRESULT messages([out, retval] IVLCMessages** iter);\r
 338 \r
 339         [propget, helpstring("Returns/Sets the log versbosity level.")]\r
 340         HRESULT verbosity([out, retval] long* level);\r
 341         [propput, helpstring("Returns/Sets the log versbosity level.")]\r
 342         HRESULT verbosity([in] long level);\r
 343     };\r
 344 \r
 345     [\r
 346       odl,\r
 347       uuid(FD37FE32-82BC-4A25-B056-315F4DBB194D),\r
 348       helpstring("VLC Playlist Items collection"),\r
 349       dual,\r
 350       oleautomation\r
 351     ]\r
 352     interface IVLCPlaylistItems : IDispatch\r
 353     {\r
 354         [propget, helpstring("Returns number of items in playlist.")]\r
 355         HRESULT count([out, retval] long* count);\r
 356 \r
 357         [helpstring("Remove all items from playlist.")]\r
 358         HRESULT clear();\r
 359 \r
 360         [helpstring("remove item from playlist.")]\r
 361         HRESULT remove([in] long itemId);\r
 362     };\r
 363 \r
 364     [\r
 365       odl,\r
 366       uuid(54613049-40BF-4035-9E70-0A9312C0188D),\r
 367       helpstring("VLC Playlist APIs"),\r
 368       dual,\r
 369       oleautomation\r
 370     ]\r
 371     interface IVLCPlaylist : IDispatch\r
 372     {\r
 373         [hidden, propget, helpstring("Returns number of items in playlist. (deprecated)")]\r
 374         HRESULT itemCount([out, retval] long* count);\r
 375 \r
 376         [propget, helpstring("Returns whether playback displays video.")]\r
 377         HRESULT isPlaying([out, retval] VARIANT_BOOL* playing);\r
 378 \r
 379         [helpstring("Add a playlist item.")]\r
 380         HRESULT add([in] BSTR uri, [in, optional] VARIANT name, [in, optional] VARIANT options, [out, retval] long* itemId);\r
 381 \r
 382         [helpstring("Play/Resume the playlist.")]\r
 383         HRESULT play();\r
 384 \r
 385         [helpstring("Play item in playlist.")]\r
 386         HRESULT playItem([in] long itemId);\r
 387 \r
 388         [helpstring("Play/Pause current clip.")]\r
 389         HRESULT togglePause();\r
 390 \r
 391         [helpstring("Stop current clip.")]\r
 392         HRESULT stop();\r
 393 \r
 394         [helpstring("Advance to next item in playlist.")]\r
 395         HRESULT next();\r
 396 \r
 397         [helpstring("Advance to previous item in playlist.")]\r
 398         HRESULT prev();\r
 399 \r
 400         [hidden, helpstring("Remove all items from playlist. (deprecated)")]\r
 401         HRESULT clear();\r
 402 \r
 403         [hidden, helpstring("Remove item from playlist. (deprecated)")]\r
 404         HRESULT removeItem([in] long item);\r
 405 \r
 406         [propget, helpstring("Returns the playlist items collection object.")]\r
 407         HRESULT items([out, retval] IVLCPlaylistItems** obj);\r
 408     };\r
 409 \r
 410     [\r
 411       odl,\r
 412       uuid(465E787A-0556-452F-9477-954E4A940003),\r
 413       helpstring("VLC Subtitle APIs"),\r
 414       dual,\r
 415       oleautomation\r
 416     ]\r
 417     interface IVLCSubtitle : IDispatch\r
 418     {\r
 419         [propget, helpstring("Returns video subtitle used.")]\r
 420         HRESULT track([out, retval] long* spu);\r
 421         [propput, helpstring("Sets video subtitle to use.")]\r
 422         HRESULT track([in] long spu);\r
 423 \r
 424         [propget, helpstring("Returns the number of video subtitles available.")]\r
 425         HRESULT count([out, retval] long* spuNumber);\r
 426         [helpstring("Returns video subtitle name.")]\r
 427         HRESULT description([in] long nameID, [out, retval] BSTR* name);\r
 428     };\r
 429 \r
 430     [\r
 431       odl,\r
 432       uuid(8D076AD6-9B6F-4150-A0FD-5D7E8C8CB02C),\r
 433       helpstring("VLC Marquee Filter"),\r
 434       dual,\r
 435       oleautomation\r
 436     ]\r
 437     interface IVLCMarquee : IDispatch\r
 438     {\r
 439         [helpstring("enable Marquee Filter.")]\r
 440         HRESULT enable();\r
 441 \r
 442         [helpstring("disable Marquee Filter.")]\r
 443         HRESULT disable();\r
 444 \r
 445         [helpstring("set text to Marquee Filter.")]\r
 446         HRESULT text([in] BSTR text);\r
 447 \r
 448         [helpstring("change text color.")]\r
 449         HRESULT color ([in] long val);\r
 450         [helpstring("change  text opacity.")]\r
 451         HRESULT opacity ([in] long val);\r
 452         [helpstring("change text position.")]\r
 453         HRESULT position ([in] long val);\r
 454         [helpstring("change refresh time.")]\r
 455         HRESULT refresh ([in] long val);\r
 456         [helpstring("change text size.")]\r
 457         HRESULT size ([in] long val);\r
 458         [helpstring("change timeout.")]\r
 459         HRESULT timeout ([in] long val);\r
 460         [helpstring("change text abcissa.")]\r
 461         HRESULT x ([in] long val);\r
 462         [helpstring("change text ordinate.")]\r
 463         HRESULT y ([in] long val);\r
 464     };\r
 465 \r
 466     [\r
 467       odl,\r
 468       uuid(0AAEDF0B-D333-4B27-A0C6-BBF31413A42E),\r
 469       helpstring("VLC Video APIs"),\r
 470       dual,\r
 471       oleautomation\r
 472     ]\r
 473     interface IVLCVideo : IDispatch\r
 474     {\r
 475         [propget, helpstring("Returns/sets the fullscreen state.")]\r
 476         HRESULT fullscreen([out, retval] VARIANT_BOOL* fullscreen);\r
 477 \r
 478         [propput, helpstring("Returns/sets the fullscreen state.")]\r
 479         HRESULT fullscreen([in] VARIANT_BOOL fullscreen);\r
 480 \r
 481         [propget, helpstring("Returns video original width.")]\r
 482         HRESULT width([out, retval] long* width);\r
 483 \r
 484         [propget, helpstring("Returns video original height.")]\r
 485         HRESULT height([out, retval] long* height);\r
 486 \r
 487         [propget, helpstring("Returns video aspect ratio.")]\r
 488         HRESULT aspectRatio([out, retval] BSTR* aspect);\r
 489         [propput, helpstring("Sets video aspect ratio.")]\r
 490         HRESULT aspectRatio([in] BSTR aspect);\r
 491 \r
 492         [propget, helpstring("Returns video subtitle used.")]\r
 493         HRESULT subtitle([out, retval] long* spu);\r
 494         [propput, helpstring("Sets video subtitle to use.")]\r
 495         HRESULT subtitle([in] long spu);\r
 496 \r
 497         [propget, helpstring("Returns crop filter geometry.")]\r
 498         HRESULT crop([out, retval] BSTR* geometry);\r
 499         [propput, helpstring("Sets crop filter geometry.")]\r
 500         HRESULT crop([in] BSTR geometry);\r
 501 \r
 502         [propget, helpstring("Returns teletext page used.")]\r
 503         HRESULT teletext([out, retval] long* page);\r
 504         [propput, helpstring("Sets teletext page to use.")]\r
 505         HRESULT teletext([in] long page);\r
 506 \r
 507         [helpstring("Enable deinterlace filter.")]\r
 508         HRESULT deinterlaceEnable([in] BSTR mode);\r
 509         [helpstring("Disable deinterlace filter.")]\r
 510         HRESULT deinterlaceDisable();\r
 511 \r
 512         [helpstring("toggle fullscreen/windowed state.")]\r
 513         HRESULT toggleFullscreen();\r
 514 \r
 515         [helpstring("take video snapshot and save it into picture object.")]\r
 516         HRESULT takeSnapshot([out, retval] IPictureDisp** picture);\r
 517 \r
 518         [helpstring("toggle teletext transparent state.")]\r
 519         HRESULT toggleTeletext();\r
 520 \r
 521         [propget, helpstring("Returns the marquee object.")]\r
 522         HRESULT marquee([out, retval] IVLCMarquee** obj);\r
 523     };\r
 524 \r
 525     [\r
 526       odl,\r
 527       uuid(2D719729-5333-406C-BF12-8DE787FD65E3),\r
 528       helpstring("VLC Control"),\r
 529       dual,\r
 530       oleautomation\r
 531     ]\r
 532     interface IVLCControl2 : IDispatch\r
 533     {\r
 534         [id(DISPID_AutoLoop), propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
 535         HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);\r
 536         [id(DISPID_AutoLoop), propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]\r
 537         HRESULT AutoLoop([in] VARIANT_BOOL autoloop);\r
 538 \r
 539         [id(DISPID_AutoPlay), propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]\r
 540         HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);\r
 541         [id(DISPID_AutoPlay), propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]\r
 542         HRESULT AutoPlay([in] VARIANT_BOOL autoplay);\r
 543 \r
 544         [id(DISPID_BaseURL), propget, helpstring("Returns/sets the base URL for relative paths")]\r
 545         HRESULT BaseURL([out, retval] BSTR* url);\r
 546         [id(DISPID_BaseURL), propput, helpstring("Returns/sets the base URL for relative paths")]\r
 547         HRESULT BaseURL([in] BSTR url);\r
 548 \r
 549         [id(DISPID_StartTime), propget, helpstring("Returns/sets playback start time of URL.")]\r
 550         HRESULT StartTime([out, retval] long* seconds);\r
 551         [id(DISPID_StartTime), propput, helpstring("Returns/sets playback start time of URL.")]\r
 552         HRESULT StartTime([in] long seconds);\r
 553 \r
 554         [id(DISPID_MRL), propget, helpstring("Returns/sets the default MRL in playlist")]\r
 555         HRESULT MRL([out, retval] BSTR* mrl);\r
 556         [id(DISPID_MRL), propput, helpstring("Returns/sets the default MRL in playlist")]\r
 557         HRESULT MRL([in] BSTR mrl);\r
 558 \r
 559         [propget, helpstring("Returns VLC Version.")]\r
 560         HRESULT VersionInfo([out, retval] BSTR* version);\r
 561 \r
 562         [id(DISPID_Visible), propget, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
 563         HRESULT Visible([out, retval] VARIANT_BOOL* visible);\r
 564         [id(DISPID_Visible), propput, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]\r
 565         HRESULT Visible([in] VARIANT_BOOL visible);\r
 566 \r
 567         [id(DISPID_Volume), propget, helpstring("Returns/sets default audio volume.")]\r
 568         HRESULT Volume([out, retval] long* volume);\r
 569         [id(DISPID_Volume), propput, helpstring("Returns/sets default audio volume.")]\r
 570         HRESULT Volume([in] long volume);\r
 571 \r
 572         [id(DISPID_BackColor), propget, helpstring("Returns/sets background color.")]\r
 573         HRESULT BackColor([out, retval] OLE_COLOR* backcolor);\r
 574         [id(DISPID_BackColor), propput, helpstring("Returns/sets background color.")]\r
 575         HRESULT BackColor([in] OLE_COLOR backcolor);\r
 576 \r
 577         /*\r
 578          * caution: vlcobject.toolbar:bool does not yet exists in Firefox\r
 579          * plugin. Official usage is through "toolbar" property for now,\r
 580          * which is compatibile with Firefox.\r
 581          */\r
 582         [id(DISPID_Toolbar), propget, helpstring("Returns/sets visibility of the toolbar")]\r
 583         HRESULT Toolbar([out, retval] VARIANT_BOOL* visible);\r
 584         [id(DISPID_Toolbar), propput, helpstring("Returns/sets visibility of the toolbar")]\r
 585         HRESULT Toolbar([in] VARIANT_BOOL visible);\r
 586 \r
 587         [propget, helpstring("Returns the audio object.")]\r
 588         HRESULT audio([out, retval] IVLCAudio** obj);\r
 589 \r
 590         [propget, helpstring("Returns the audio object.")]\r
 591         HRESULT input([out, retval] IVLCInput** obj);\r
 592 \r
 593         [propget, helpstring("Returns the log object.")]\r
 594         HRESULT log([out, retval] IVLCLog** obj);\r
 595 \r
 596         [propget, helpstring("Returns the playlist object.")]\r
 597         HRESULT playlist([out, retval] IVLCPlaylist** obj);\r
 598 \r
 599         [propget, helpstring("Returns the audio object.")]\r
 600         HRESULT subtitle([out, retval] IVLCSubtitle** obj);\r
 601 \r
 602         [propget, helpstring("Returns the audio object.")]\r
 603         HRESULT video([out, retval] IVLCVideo** obj);\r
 604     };\r
 605 \r
 606     [\r
 607       uuid(E23FE9C6-778E-49D4-B537-38FCDE4887D8),\r
 608       helpstring("VLC control (deprecated)"),\r
 609       control\r
 610     ]\r
 611     coclass VLCPlugin\r
 612     {\r
 613         [default] interface IVLCControl;\r
 614         interface IVLCControl2;\r
 615         [default, source] dispinterface DVLCEvents;\r
 616     };\r
 617 \r
 618     [\r
 619       uuid(9BE31822-FDAD-461B-AD51-BE1D1C159921),\r
 620       helpstring("VLC control"),\r
 621       control\r
 622     ]\r
 623     coclass VLCPlugin2\r
 624     {\r
 625         [default] interface IVLCControl2;\r
 626         interface IVLCControl;\r
 627     };\r
 628 };\r