src/third_party/WebKit/public/platform/WebSourceInfo.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 GOOGLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL GOOGLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebSourceInfo_h
  27 #define WebSourceInfo_h
  28
  29 #include "WebCommon.h"
  30 #include "WebNonCopyable.h"
  31 #include "WebPrivatePtr.h"
  32 #include "WebString.h"
  33
  34 namespace blink {
  35
  36 class WebSourceInfoPrivate;
  37
  38 class WebSourceInfo {
  39 public:
  40     enum SourceKind {
  41         SourceKindNone,
  42         SourceKindAudio,
  43         SourceKindVideo
  44     };
  45
  46     enum VideoFacingMode {
  47         VideoFacingModeNone,
  48         VideoFacingModeUser,
  49         VideoFacingModeEnvironment
  50     };
  51
  52     WebSourceInfo() { }
  53     WebSourceInfo(const WebSourceInfo& other) { assign(other); }
  54     ~WebSourceInfo() { reset(); }
  55
  56     WebSourceInfo& operator=(const WebSourceInfo& other)
  57     {
  58         assign(other);
  59         return *this;
  60     }
  61
  62     BLINK_PLATFORM_EXPORT void assign(const WebSourceInfo&);
  63
  64     BLINK_PLATFORM_EXPORT void initialize(const WebString& id, SourceKind, const WebString& label, VideoFacingMode);
  65     BLINK_PLATFORM_EXPORT void reset();
  66     bool isNull() const { return m_private.isNull(); }
  67
  68     BLINK_PLATFORM_EXPORT WebString id() const;
  69     BLINK_PLATFORM_EXPORT SourceKind kind() const;
  70     BLINK_PLATFORM_EXPORT WebString label() const;
  71     BLINK_PLATFORM_EXPORT VideoFacingMode facing() const;
  72
  73 private:
  74     WebPrivatePtr<WebSourceInfoPrivate> m_private;
  75 };
  76
  77 } // namespace blink
  78
  79 #endif // WebSourceInfo_h