axvlc.idl 27.7 KB
Newer Older
1 2 3 4
/*****************************************************************************
 * axvlc.idl: ActiveX control for VLC
 *****************************************************************************
 * Copyright (C) 2006 the VideoLAN team
5
 * Copyright (C) 2010 M2X BV
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * Authors: Damien Fouilleul <Damien.Fouilleul@laposte.net>
 *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

25 26 27 28
// comments terminated by [t] are by tonsofpcs, regarding the string
// review. April 02, 2006. [t]
// Possibly change all instances of "the current playlist" to "the
// playlist" and "current playlist" to "the playlist" [t]
29 30 31 32 33 34 35 36 37 38 39 40

import "ocidl.idl";

[
  uuid(DF2BBE39-40A8-433b-A279-073F48DA94B6),
  version(1.0),
  helpstring("VideoLAN VLC ActiveX Plugin")
]
library AXVLC
{
    // Forward declare all types defined in this typelib
    interface IVLCAudio;
41
    interface IVLCChapter;
42
    interface IVLCInput;
43
    interface IVLCLogo;
44
    interface IVLCDeinterlace;
45
    interface IVLCMarquee;
46
    interface IVLCPlaylist;
47
    interface IVLCSubtitle;
48
    interface IVLCTitle;
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    interface IVLCVideo;
    interface IVLCControl2;
    dispinterface DVLCEvents;

    importlib("stdole2.tlb");

    typedef [public] enum VLCPlaylistMode
    {
        VLCPlayListInsert       =  1,
        VLCPlayListInsertAndGo  =  9,
        VLCPlayListReplace      =  2,
        VLCPlayListReplaceAndGo = 10,
        VLCPlayListAppend       =  4,
        VLCPlayListAppendAndGo  = 12,
        VLCPlayListCheckInsert  = 16
    } eVLCPlaylistMode;

    const int DISPID_Visible    = 100;
67

68
    /* async events from libvlc */
69 70 71 72 73 74 75 76 77 78
    const int DISPID_MediaPlayerNothingSpecialEvent = 200;
    const int DISPID_MediaPlayerOpeningEvent = 201;
    const int DISPID_MediaPlayerBufferingEvent = 202;
    const int DISPID_MediaPlayerPlayingEvent = 203;
    const int DISPID_MediaPlayerPausedEvent = 204;
    const int DISPID_MediaPlayerForwardEvent = 205;
    const int DISPID_MediaPlayerBackwardEvent = 206;
    const int DISPID_MediaPlayerEncounteredErrorEvent = 207;
    const int DISPID_MediaPlayerEndReachedEvent = 208;
    const int DISPID_MediaPlayerStoppedEvent = 209;
79

80 81 82 83
    const int DISPID_MediaPlayerTimeChangedEvent = 210;
    const int DISPID_MediaPlayerPositionChangedEvent = 211;
    const int DISPID_MediaPlayerSeekableChangedEvent = 212;
    const int DISPID_MediaPlayerPausableChangedEvent = 213;
84 85 86
    const int DISPID_MediaPlayerMediaChangedEvent = 214;
    const int DISPID_MediaPlayerTitleChangedEvent = 215;
    const int DISPID_MediaPlayerLengthChangedEvent = 216;
87 88 89 90 91 92
    const int DISPID_MediaPlayerChapterChangedEvent = 217;

    const int DISPID_MediaPlayerVoutEvent = 218;
    const int DISPID_MediaPlayerMutedEvent = 219;
    const int DISPID_MediaPlayerUnmutedEvent = 220;
    const int DISPID_MediaPlayerAudioVolumeEvent = 221;
93

94 95 96 97 98 99 100 101
    [
      uuid(DF48072F-5EF8-434e-9B40-E2F3AE759B5F),
      helpstring("Event interface for VLC control"),
    ]
    dispinterface DVLCEvents
    {
        properties:
        methods:
102
            /* async events from libvlc */
103 104 105 106 107
            [id(DISPID_MediaPlayerNothingSpecialEvent), helpstring("Idle state")]
            void MediaPlayerNothingSpecial();
            [id(DISPID_MediaPlayerOpeningEvent), helpstring("Opening media")]
            void MediaPlayerOpening();
            [id(DISPID_MediaPlayerBufferingEvent), helpstring("Buffering media")]
108
            void MediaPlayerBuffering([in] long cache);
109 110 111 112 113 114 115 116 117 118 119 120 121 122
            [id(DISPID_MediaPlayerPlayingEvent), helpstring("Media is playing")]
            void MediaPlayerPlaying();
            [id(DISPID_MediaPlayerPausedEvent), helpstring("Media is paused")]
            void MediaPlayerPaused();
            [id(DISPID_MediaPlayerForwardEvent), helpstring("Forward playback")]
            void MediaPlayerForward();
            [id(DISPID_MediaPlayerBackwardEvent), helpstring("Backward playback")]
            void MediaPlayerBackward();
            [id(DISPID_MediaPlayerEncounteredErrorEvent), helpstring("An error has been encountered")]
            void MediaPlayerEncounteredError();
            [id(DISPID_MediaPlayerEndReachedEvent), helpstring("End of playback reached")]
            void MediaPlayerEndReached();
            [id(DISPID_MediaPlayerStoppedEvent), helpstring("Playback stopped")]
            void MediaPlayerStopped();
123

124 125 126
            [id(DISPID_MediaPlayerTimeChangedEvent), helpstring("Time changed")]
            void MediaPlayerTimeChanged([in] long time);
            [id(DISPID_MediaPlayerPositionChangedEvent), helpstring("Position changed")]
127
            void MediaPlayerPositionChanged([in] float position);
128 129 130 131
            [id(DISPID_MediaPlayerSeekableChangedEvent), helpstring("Seek changed")]
            void MediaPlayerSeekableChanged([in] VARIANT_BOOL seekable);
            [id(DISPID_MediaPlayerPausableChangedEvent), helpstring("Pause setting changed")]
            void MediaPlayerPausableChanged([in] VARIANT_BOOL pausable);
132 133 134 135 136 137
            [id(DISPID_MediaPlayerMediaChangedEvent), helpstring("Media changed")]
            void MediaPlayerMediaChanged();
            [id(DISPID_MediaPlayerTitleChangedEvent), helpstring("Title changed")]
            void MediaPlayerTitleChanged([in] int title);
            [id(DISPID_MediaPlayerLengthChangedEvent), helpstring("Length changed")]
            void MediaPlayerLengthChanged([in] long length);
138 139 140 141 142 143 144 145 146 147 148
            [id(DISPID_MediaPlayerChapterChangedEvent), helpstring("Chapter changed")]
            void MediaPlayerChapterChanged([in] int chapter);

            [id(DISPID_MediaPlayerVoutEvent), helpstring("Number of vout changed")]
            void MediaPlayerVout([in] int count);
            [id(DISPID_MediaPlayerMutedEvent), helpstring("Audio muted")]
            void MediaPlayerMuted();
            [id(DISPID_MediaPlayerUnmutedEvent), helpstring("Audio unmuted")]
            void MediaPlayerUnmuted();
            [id(DISPID_MediaPlayerAudioVolumeEvent), helpstring("Audio volume changed")]
            void MediaPlayerAudioVolume([in] float volume);
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
    };

    [
      odl,
      uuid(9E0BD17B-2D3C-4656-B94D-03084F3FD9D4),
      helpstring("VLC Audio APIs"),
      dual,
      oleautomation
    ]
    interface IVLCAudio : IDispatch
    {
        [propget, helpstring("Returns/sets the audio mute state.")]
        HRESULT mute([out, retval] VARIANT_BOOL* muted);
        [propput, helpstring("Returns/sets the audio mute state.")]
        HRESULT mute([in] VARIANT_BOOL muted);

        [propget, helpstring("Returns/sets audio volume as a percent value.")]
        HRESULT volume([out, retval] long* volume);
        [propput, helpstring("Returns/sets audio volume as a percent value.")]
        HRESULT volume([in] long volume);

        [helpstring("Mute/unmute audio playback.")]
        HRESULT toggleMute();

        [propget, helpstring("Returns/sets audio track used/to use.")]
        HRESULT track([out, retval] long* track);
        [propput, helpstring("Returns/sets audio track used/to use.")]
        HRESULT track([in] long track);

178 179 180 181 182
        [propget, helpstring("Returns the number of audio tracks available.")]
        HRESULT count([out, retval] long* trackNumber);
        [helpstring("Returns audio track name.")]
        HRESULT description([in] long trackID, [out, retval] BSTR* name);

183 184 185 186 187 188
        [propget, helpstring("Returns audio channel [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]
        HRESULT channel([out, retval] long* channel);
        [propput, helpstring("Sets audio channel to [1-5] indicating; stereo, reverse stereo, left, right, dolby.")]
        HRESULT channel([in] long channel);
    };

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    [
      odl,
      uuid(b5def5a1-ffb6-4e68-b3d8-a12ac60fda54),
      helpstring("VLC Title APIs"),
      dual,
      oleautomation
    ]
    interface IVLCTitle : IDispatch
    {
        [propget, helpstring("Returns the number of title tracks available.")]
        HRESULT count([out, retval] long* countTracks);

        [propget, helpstring("Returns/sets title track used/to use.")]
        HRESULT track([out, retval] long* track);
        [propput, helpstring("Returns/sets title track used/to use.")]
        HRESULT track([in] long track);

        [helpstring("Returns the current title track name.")]
        HRESULT description([in] long track, [out, retval] BSTR* name);
    };

    [
      odl,
      uuid(5af314cf-8849-4a79-a3fc-8de6625d9e72),
      helpstring("VLC Chapter APIs"),
      dual,
      oleautomation
    ]
    interface IVLCChapter : IDispatch
    {
        [propget, helpstring("Returns the number of chapter tracks available.")]
        HRESULT count([out, retval] long* countTracks);

        [helpstring("Returns the number of chapter tracks available of a specific title.")]
        HRESULT countForTitle([in] long title, [out, retval] long* countTracks);

        [propget, helpstring("Returns/sets chapter track used/to use.")]
        HRESULT track([out, retval] long* track);
        [propput, helpstring("Returns/sets chapter track used/to use.")]
        HRESULT track([in] long track);

        [helpstring("Returns the current chapter track name.")]
        HRESULT description([in] long title, [in] long chapter, [out, retval] BSTR* name);

        [helpstring("Advance to next chapter in current title.")]
        HRESULT next();

        [helpstring("Advance to previous chapter in current title.")]
        HRESULT prev();
    };

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    [
      odl,
      uuid(49E0DBD1-9440-466C-9C97-95C67190C603),
      helpstring("VLC Input APIs"),
      dual,
      oleautomation
    ]
    interface IVLCInput : IDispatch
    {
        [propget, helpstring("Returns the clip length, in milliseconds.")]
        HRESULT length([out, retval] double* length);

        [propget, helpstring("Returns/sets playback position in current clip.  Position is ranging from 0.0 to 1.0.")]
        HRESULT position([out, retval] double* position);
        [propput, helpstring("Returns/sets playback position in the current clip.  Position ranging from 0.0 to 1.0.")]
        HRESULT position([in] double position);

        [propget, helpstring("Returns/sets playback time in current clip, in milliseconds.")]
        HRESULT time([out, retval] double* time);
        [propput, helpstring("Returns/sets playback time in the current clip, in milliseconds.")]
        HRESULT time([in] double time);

        [propget, helpstring("Returns current playback state.")]
        HRESULT state([out, retval] long* state);

        [propget, helpstring("Returns/sets current playback rate, normal rate is 1.0 ")]
        HRESULT rate([out, retval] double* rate);
        [propput, helpstring("Returns/sets current playback rate, normal rate is 1.0.")]
        HRESULT rate([in] double rate);

        [propget, helpstring("Returns current playback frames per seconds if available.")]
        HRESULT fps([out, retval] double* fps);

        [propget, helpstring("Returns whether current playback displays video.")]
        HRESULT hasVout([out, retval] VARIANT_BOOL* hasVout);
275 276 277 278 279 280

        [propget, helpstring("Returns the title object.")]
        HRESULT title([out, retval] IVLCTitle** obj);

        [propget, helpstring("Returns the chapter object.")]
        HRESULT chapter([out, retval] IVLCChapter** obj);
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
    };

    [
      odl,
      uuid(FD37FE32-82BC-4A25-B056-315F4DBB194D),
      helpstring("VLC Playlist Items collection"),
      dual,
      oleautomation
    ]
    interface IVLCPlaylistItems : IDispatch
    {
        [propget, helpstring("Returns number of items in playlist.")]
        HRESULT count([out, retval] long* count);

        [helpstring("Remove all items from playlist.")]
        HRESULT clear();

        [helpstring("remove item from playlist.")]
        HRESULT remove([in] long itemId);
    };

    [
      odl,
      uuid(54613049-40BF-4035-9E70-0A9312C0188D),
      helpstring("VLC Playlist APIs"),
      dual,
      oleautomation
    ]
    interface IVLCPlaylist : IDispatch
    {
        [hidden, propget, helpstring("Returns number of items in playlist. (deprecated)")]
        HRESULT itemCount([out, retval] long* count);

        [propget, helpstring("Returns whether playback displays video.")]
        HRESULT isPlaying([out, retval] VARIANT_BOOL* playing);

317
        [propget, helpstring("Returns index of current item in playlist.")]
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
318
        HRESULT currentItem([out, retval] long* index);
319

320 321 322 323 324 325 326 327 328
        [helpstring("Add a playlist item.")]
        HRESULT add([in] BSTR uri, [in, optional] VARIANT name, [in, optional] VARIANT options, [out, retval] long* itemId);

        [helpstring("Play/Resume the playlist.")]
        HRESULT play();

        [helpstring("Play item in playlist.")]
        HRESULT playItem([in] long itemId);

329 330 331
        [helpstring("Pause the playlist.")]
        HRESULT pause();

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
        [helpstring("Play/Pause current clip.")]
        HRESULT togglePause();

        [helpstring("Stop current clip.")]
        HRESULT stop();

        [helpstring("Advance to next item in playlist.")]
        HRESULT next();

        [helpstring("Advance to previous item in playlist.")]
        HRESULT prev();

        [hidden, helpstring("Remove all items from playlist. (deprecated)")]
        HRESULT clear();

        [hidden, helpstring("Remove item from playlist. (deprecated)")]
        HRESULT removeItem([in] long item);

        [propget, helpstring("Returns the playlist items collection object.")]
        HRESULT items([out, retval] IVLCPlaylistItems** obj);
352 353 354

        [helpstring("Parse the head media from playlist")]
        HRESULT parse([in] long options, [in] long timeout_ms, [out, retval] long* status);
355 356 357 358
    };

    [
      odl,
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
      uuid(465E787A-0556-452F-9477-954E4A940003),
      helpstring("VLC Subtitle APIs"),
      dual,
      oleautomation
    ]
    interface IVLCSubtitle : IDispatch
    {
        [propget, helpstring("Returns video subtitle used.")]
        HRESULT track([out, retval] long* spu);
        [propput, helpstring("Sets video subtitle to use.")]
        HRESULT track([in] long spu);

        [propget, helpstring("Returns the number of video subtitles available.")]
        HRESULT count([out, retval] long* spuNumber);
        [helpstring("Returns video subtitle name.")]
        HRESULT description([in] long nameID, [out, retval] BSTR* name);
    };

377 378 379 380 381 382 383 384 385 386 387 388 389 390
    [
      odl,
      uuid(8D076AD6-9B6F-4150-A0FD-5D7E8C8CB02C),
      helpstring("VLC Marquee Filter"),
      dual,
      oleautomation
    ]
    interface IVLCMarquee : IDispatch
    {
        [helpstring("enable Marquee Filter.")]
        HRESULT enable();
        [helpstring("disable Marquee Filter.")]
        HRESULT disable();

391 392 393 394
        [propget, helpstring("Retrieve marquee text.")]
        HRESULT text([out, retval] BSTR* val);
        [propput, helpstring("Change marquee text.")]
        HRESULT text([in] BSTR val);
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
        [propget, helpstring("Retrieve text color.")]
        HRESULT color([out, retval] LONG* val);
        [propput, helpstring("Change text color.")]
        HRESULT color([in] LONG val);
        [propget, helpstring("Retrieve text opacity.")]
        HRESULT opacity([out, retval] LONG* val);
        [propput, helpstring("Set text opacity (0=transparent, 255=opaque).")]
        HRESULT opacity([in] LONG val);
        [propget, helpstring("Retrieve text position.")]
        HRESULT position([out, retval] BSTR* val);
        [propput, helpstring("Text positioning relative to: center, left, right, top, bottom, top-left, top-right, bottom-left, bottom-right.")]
        HRESULT position([in] BSTR val);
        [propget, helpstring("Retrieve text refresh time.")]
        HRESULT refresh([out, retval] LONG* val);
        [propput, helpstring("Set text refresh time.")]
        HRESULT refresh([in] LONG val);
        [propget, helpstring("Retrieve text size.")]
        HRESULT size([out, retval] LONG* val);
        [propput, helpstring("Set text size.")]
        HRESULT size([in] LONG val);
        [propget, helpstring("Retrieve timeout.")]
        HRESULT timeout([out, retval] LONG* val);
        [propput, helpstring("Change timeout.")]
        HRESULT timeout([in] LONG val);
        [propget, helpstring("Retrieve text abcissa.")]
        HRESULT x([out, retval] LONG* val);
        [propput, helpstring("Change text abcissa.")]
        HRESULT x([in] LONG val);
        [propget, helpstring("Retrieve text ordinate.")]
        HRESULT y([out, retval] LONG* val);
        [propput, helpstring("Change text ordinate.")]
        HRESULT y([in] LONG val);
428 429
    };

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    [
      odl,
      uuid(8a4a20c2-93f3-44e8-8644-beb2e3487e84),
      helpstring("VLC Logo Filter"),
      dual,
      oleautomation
    ]
    interface IVLCLogo : IDispatch
    {
        [helpstring("Enable the logo filter.")]
        HRESULT enable();
        [helpstring("Disable the logo filter.")]
        HRESULT disable();

        [helpstring("specify input file[[,delay],alpha].")]
        HRESULT file([in] BSTR fname);

        [propget, helpstring("")]
        HRESULT delay([out, retval] long* val);
        [propput, helpstring("Set delay-to-next-picture in miliseconds.")]
        HRESULT delay([in] long val);

        [propget, helpstring("")]
        HRESULT repeat([out, retval] long* val);
        [propput, helpstring("Repeat: -1 continuous (default), 0 no repeat, ....")]
        HRESULT repeat([in] long val);

        [propget, helpstring("Returns the `global' alpha value.")]
        HRESULT opacity([out, retval] long* val);
        [propput, helpstring("Alpha value: 0 opaque to 255 fully transparent")]
        HRESULT opacity([in] long val);

        [propget, helpstring("Retrieve picture position.")]
        HRESULT position([out, retval] BSTR* val);
        [propput, helpstring("Picture positioning relative to: center, left, right, top, bottom, top-left, top-right, bottom-left, bottom-right.")]
        HRESULT position([in] BSTR val);

        [propget, helpstring("Picture x offset.")]
        HRESULT x([out, retval] long* val);
        [propput, helpstring("Picture x offset.")]
        HRESULT x([in] long val);
        [propget, helpstring("Picture y offset.")]
        HRESULT y([out, retval] long* val);
        [propput, helpstring("Picture y offset.")]
        HRESULT y([in] long val);

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    };
    [
      odl,
      uuid(bc97469f-cb11-4037-8dce-5fc9f5f85307),
      helpstring("VLC Deinterlace Filter"),
      dual,
      oleautomation
    ]
    interface IVLCDeinterlace : IDispatch
    {
        [helpstring("Enable deinterlace filter and set method.")]
        HRESULT enable([in] BSTR mode);
        [helpstring("Disable deinterlace filter.")]
        HRESULT disable();

491 492
    };

493 494
    [
      odl,
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
      uuid(0AAEDF0B-D333-4B27-A0C6-BBF31413A42E),
      helpstring("VLC Video APIs"),
      dual,
      oleautomation
    ]
    interface IVLCVideo : IDispatch
    {
        [propget, helpstring("Returns/sets the fullscreen state.")]
        HRESULT fullscreen([out, retval] VARIANT_BOOL* fullscreen);

        [propput, helpstring("Returns/sets the fullscreen state.")]
        HRESULT fullscreen([in] VARIANT_BOOL fullscreen);

        [propget, helpstring("Returns video original width.")]
        HRESULT width([out, retval] long* width);

        [propget, helpstring("Returns video original height.")]
        HRESULT height([out, retval] long* height);

        [propget, helpstring("Returns video aspect ratio.")]
        HRESULT aspectRatio([out, retval] BSTR* aspect);
        [propput, helpstring("Sets video aspect ratio.")]
        HRESULT aspectRatio([in] BSTR aspect);

519 520 521 522 523
        [propget, helpstring("Returns video scale.")]
        HRESULT scale([out, retval] float* aspect);
        [propput, helpstring("Sets video scale.")]
        HRESULT scale([in] float aspect);

524 525 526 527 528 529 530 531 532 533 534
        [propget, helpstring("Returns video subtitle used.")]
        HRESULT subtitle([out, retval] long* spu);
        [propput, helpstring("Sets video subtitle to use.")]
        HRESULT subtitle([in] long spu);

        [propget, helpstring("Returns crop filter geometry.")]
        HRESULT crop([out, retval] BSTR* geometry);
        [propput, helpstring("Sets crop filter geometry.")]
        HRESULT crop([in] BSTR geometry);

        [propget, helpstring("Returns teletext page used.")]
535
        HRESULT teletext([out, retval] long* page);
536
        [propput, helpstring("Sets teletext page to use.")]
537
        HRESULT teletext([in] long page);
538 539 540 541 542 543 544 545 546

        [helpstring("toggle fullscreen/windowed state.")]
        HRESULT toggleFullscreen();

        [helpstring("take video snapshot and save it into picture object.")]
        HRESULT takeSnapshot([out, retval] IPictureDisp** picture);

        [helpstring("toggle teletext transparent state.")]
        HRESULT toggleTeletext();
547

548 549 550 551 552 553 554 555 556 557
        [propget, helpstring("Returns/sets video track used/to use.")]
        HRESULT track([out, retval] long* track);
        [propput, helpstring("Returns/sets video track used/to use.")]
        HRESULT track([in] long track);

        [propget, helpstring("Returns the number of video tracks available.")]
        HRESULT count([out, retval] long* trackNumber);
        [helpstring("Returns video track name.")]
        HRESULT description([in] long trackID, [out, retval] BSTR* name);

558 559
        [propget, helpstring("Returns the marquee object.")]
        HRESULT marquee([out, retval] IVLCMarquee** obj);
560 561 562

        [propget, helpstring("Returns the logo object.")]
        HRESULT logo([out, retval] IVLCLogo** obj);
563 564 565

        [propget, helpstring("Returns the logo object.")]
        HRESULT deinterlace([out, retval] IVLCDeinterlace** obj);
566 567
    };

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
    [
      odl,
      uuid(796A2C2D-5B11-4fb5-9077-56D5E674972B),
      helpstring("VLC Media Description"),
      dual,
      oleautomation
    ]
    interface IVLCMediaDescription : IDispatch
    {
        [propget]
        HRESULT title([out, retval] BSTR* val);
        [propget]
        HRESULT artist([out, retval] BSTR* val);
        [propget]
        HRESULT genre([out, retval] BSTR* val);
        [propget]
        HRESULT copyright([out, retval] BSTR* val);
        [propget]
        HRESULT album([out, retval] BSTR* val);
        [propget]
        HRESULT trackNumber([out, retval] BSTR* val);
        [propget]
        HRESULT description([out, retval] BSTR* val);
        [propget]
        HRESULT rating([out, retval] BSTR* val);
        [propget]
        HRESULT date([out, retval] BSTR* val);
        [propget]
        HRESULT setting([out, retval] BSTR* val);
        [propget]
        HRESULT URL([out, retval] BSTR* val);
        [propget]
        HRESULT language([out, retval] BSTR* val);
        [propget]
        HRESULT nowPlaying([out, retval] BSTR* val);
        [propget]
        HRESULT publisher([out, retval] BSTR* val);
        [propget]
        HRESULT encodedBy([out, retval] BSTR* val);
        [propget]
        HRESULT artworkURL([out, retval] BSTR* val);
        [propget]
        HRESULT trackID([out, retval] BSTR* val);
    }

613 614 615 616 617 618 619 620 621
    [
      odl,
      uuid(2D719729-5333-406C-BF12-8DE787FD65E3),
      helpstring("VLC Control"),
      dual,
      oleautomation
    ]
    interface IVLCControl2 : IDispatch
    {
622
        [propget, helpstring("Returns/sets a value that determines whether the playlist is looped")]
623
        HRESULT AutoLoop([out, retval] VARIANT_BOOL* autoloop);
624
        [propput, helpstring("Returns/sets a value that determines whether the playlist is looped")]
625 626
        HRESULT AutoLoop([in] VARIANT_BOOL autoloop);

627
        [propget, helpstring("Returns/sets a value that determines whether the playlist is played on startup")]
628
        HRESULT AutoPlay([out, retval] VARIANT_BOOL* autoplay);
629
        [propput, helpstring("Returns/Sets a value that determines whether the playlist is played on startup")]
630 631
        HRESULT AutoPlay([in] VARIANT_BOOL autoplay);

632
        [propget, helpstring("Returns/sets the base URL for relative paths")]
633
        HRESULT BaseURL([out, retval] BSTR* url);
634
        [propput, helpstring("Returns/sets the base URL for relative paths")]
635 636
        HRESULT BaseURL([in] BSTR url);

637
        [propget, helpstring("Returns/sets playback start time of URL.")]
638
        HRESULT StartTime([out, retval] long* seconds);
639
        [propput, helpstring("Returns/sets playback start time of URL.")]
640 641
        HRESULT StartTime([in] long seconds);

642
        [propget, helpstring("Returns/sets the default MRL in playlist")]
643
        HRESULT MRL([out, retval] BSTR* mrl);
644
        [propput, helpstring("Returns/sets the default MRL in playlist")]
645 646
        HRESULT MRL([in] BSTR mrl);

647
        [propget, helpstring("Returns the VLC version")]
648 649
        HRESULT VersionInfo([out, retval] BSTR* version);

650 651
        [helpstring("Returns the VLC version")]
        HRESULT getVersionInfo([out, retval] BSTR* version);
652

653
        [propget, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
654
        HRESULT Visible([out, retval] VARIANT_BOOL* visible);
655
        [propput, helpstring("Returns/sets a value that determines whether viewing area is visible or hidden.")]
656 657
        HRESULT Visible([in] VARIANT_BOOL visible);

658
        [propget, helpstring("Returns/sets default audio volume.")]
659
        HRESULT Volume([out, retval] long* volume);
660
        [propput, helpstring("Returns/sets default audio volume.")]
661 662
        HRESULT Volume([in] long volume);

663
        [propget, helpstring("Returns/sets background color.")]
664
        HRESULT BackColor([out, retval] OLE_COLOR* backcolor);
665
        [propput, helpstring("Returns/sets background color.")]
666 667
        HRESULT BackColor([in] OLE_COLOR backcolor);

668 669 670 671 672
        /*
         * caution: vlcobject.toolbar:bool does not yet exists in Firefox
         * plugin. Official usage is through "toolbar" property for now,
         * which is compatibile with Firefox.
         */
673
        [propget, helpstring("Returns/sets visibility of the toolbar")]
674
        HRESULT Toolbar([out, retval] VARIANT_BOOL* visible);
675
        [propput, helpstring("Returns/sets visibility of the toolbar")]
676 677
        HRESULT Toolbar([in] VARIANT_BOOL visible);

678 679 680 681 682 683 684 685 686 687
        [propget, helpstring("Returns the audio object.")]
        HRESULT audio([out, retval] IVLCAudio** obj);

        [propget, helpstring("Returns the input object.")]
        HRESULT input([out, retval] IVLCInput** obj);

        [propget, helpstring("Returns the playlist object.")]
        HRESULT playlist([out, retval] IVLCPlaylist** obj);

        [propget, helpstring("Returns the subtitle object.")]
688 689
        HRESULT subtitle([out, retval] IVLCSubtitle** obj);

690
        [propget, helpstring("Returns the video object.")]
691
        HRESULT video([out, retval] IVLCVideo** obj);
692

693
        [propget, helpstring("Returns/sets availability of fullscreen mode.")]
694
        HRESULT FullscreenEnabled([out, retval] VARIANT_BOOL* enabled);
695
        [propput, helpstring("Returns/sets availability of fullscreen mode.")]
696
        HRESULT FullscreenEnabled([in] VARIANT_BOOL enabled);
697 698 699

        [propget, helpstring("Returns the media description object.")]
        HRESULT mediaDescription([out, retval] IVLCMediaDescription** obj);
700 701 702 703 704

        [propget, helpstring("Returns/sets visibility of the VLC branding.")]
        HRESULT Branding([out, retval] VARIANT_BOOL* visible);
        [propput, helpstring("Returns/sets visibility of the VLC branding.")]
        HRESULT Branding([in] VARIANT_BOOL visible);
705 706 707 708 709 710 711 712 713 714
    };

    [
      uuid(9BE31822-FDAD-461B-AD51-BE1D1C159921),
      helpstring("VLC control"),
      control
    ]
    coclass VLCPlugin2
    {
        [default] interface IVLCControl2;
715
        [default, source] dispinterface DVLCEvents;
716 717
    };
};