src/third_party/WebKit/Source/modules/mediastream/MediaStream.idl

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1.  Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 // http://dev.w3.org/2011/webrtc/editor/getusermedia.html#idl-def-MediaStream
  26
  27 [
  28     GarbageCollected,
  29     Constructor,
  30     Constructor(MediaStream stream),
  31     Constructor(MediaStreamTrack[] tracks),
  32     ConstructorCallWith=ExecutionContext,
  33     NoInterfaceObject,
  34 ] interface MediaStream : EventTarget {
  35     // DEPRECATED
  36     readonly attribute DOMString label;
  37
  38     readonly attribute DOMString id;
  39
  40     sequence<MediaStreamTrack> getAudioTracks();
  41     sequence<MediaStreamTrack> getVideoTracks();
  42     sequence<MediaStreamTrack> getTracks();
  43
  44     [RaisesException] void addTrack(MediaStreamTrack track);
  45     [RaisesException] void removeTrack(MediaStreamTrack track);
  46     MediaStreamTrack getTrackById(DOMString trackId);
  47     [CallWith=ExecutionContext] MediaStream clone();
  48
  49     readonly attribute boolean ended;
  50
  51     // DEPRECATED
  52     void stop();
  53
  54     attribute EventHandler onended;
  55     attribute EventHandler onaddtrack;
  56     attribute EventHandler onremovetrack;
  57 };