third_party/WebKit/public/platform/WebMediaStream.h

   1 /*
   2  * Copyright (C) 2013 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 #ifndef WebMediaStream_h
  26 #define WebMediaStream_h
  27
  28 #include "WebCommon.h"
  29 #include "WebNonCopyable.h"
  30 #include "WebPrivatePtr.h"
  31 #include "WebVector.h"
  32
  33 namespace blink {
  34
  35 class MediaStreamDescriptor;
  36 class WebMediaStreamTrack;
  37 class WebString;
  38
  39 class WebMediaStream {
  40 public:
  41     class ExtraData {
  42     public:
  43         virtual ~ExtraData() { }
  44     };
  45
  46     WebMediaStream() { }
  47     WebMediaStream(const WebMediaStream& other) { assign(other); }
  48     ~WebMediaStream() { reset(); }
  49
  50     WebMediaStream& operator=(const WebMediaStream& other)
  51     {
  52         assign(other);
  53         return *this;
  54     }
  55
  56     BLINK_PLATFORM_EXPORT void assign(const WebMediaStream&);
  57
  58     BLINK_PLATFORM_EXPORT void initialize(const WebVector<WebMediaStreamTrack>& audioTracks, const WebVector<WebMediaStreamTrack>& videoTracks);
  59     BLINK_PLATFORM_EXPORT void initialize(const WebString& label, const WebVector<WebMediaStreamTrack>& audioTracks, const WebVector<WebMediaStreamTrack>& videoTracks);
  60
  61     BLINK_PLATFORM_EXPORT void reset();
  62     bool isNull() const { return m_private.isNull(); }
  63
  64     BLINK_PLATFORM_EXPORT WebString id() const;
  65
  66     BLINK_PLATFORM_EXPORT void audioTracks(WebVector<WebMediaStreamTrack>&) const;
  67     BLINK_PLATFORM_EXPORT void videoTracks(WebVector<WebMediaStreamTrack>&) const;
  68
  69     BLINK_PLATFORM_EXPORT void addTrack(const WebMediaStreamTrack&);
  70     BLINK_PLATFORM_EXPORT void removeTrack(const WebMediaStreamTrack&);
  71
  72     // Extra data associated with this WebMediaStream.
  73     // If non-null, the extra data pointer will be deleted when the object is destroyed.
  74     // Setting the extra data pointer will cause any existing non-null
  75     // extra data pointer to be deleted.
  76     BLINK_PLATFORM_EXPORT ExtraData* extraData() const;
  77     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
  78
  79 #if INSIDE_BLINK
  80     BLINK_PLATFORM_EXPORT WebMediaStream(MediaStreamDescriptor*);
  81     BLINK_PLATFORM_EXPORT WebMediaStream(const WTF::PassRefPtr<MediaStreamDescriptor>&);
  82     BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<MediaStreamDescriptor>() const;
  83     BLINK_PLATFORM_EXPORT operator MediaStreamDescriptor*() const;
  84     BLINK_PLATFORM_EXPORT WebMediaStream& operator=(const WTF::PassRefPtr<MediaStreamDescriptor>&);
  85 #endif
  86
  87 private:
  88     WebPrivatePtr<MediaStreamDescriptor> m_private;
  89 };
  90
  91 } // namespace blink
  92
  93 #endif // WebMediaStream_h