third_party/WebKit/public/platform/WebMediaConstraints.h

   1 /*
   2  * Copyright (C) 2012 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 are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebMediaConstraints_h
  32 #define WebMediaConstraints_h
  33
  34 #include "WebCommon.h"
  35 #include "WebNonCopyable.h"
  36 #include "WebPrivatePtr.h"
  37 #include "WebString.h"
  38 #include "WebVector.h"
  39
  40 namespace blink {
  41
  42 class WebMediaConstraintsPrivate;
  43
  44 struct WebMediaConstraint {
  45     WebMediaConstraint()
  46     {
  47     }
  48
  49     WebMediaConstraint(WebString name, WebString value)
  50         : m_name(name)
  51         , m_value(value)
  52     {
  53     }
  54
  55     WebString m_name;
  56     WebString m_value;
  57 };
  58
  59 class WebMediaConstraints {
  60 public:
  61     WebMediaConstraints() { }
  62     WebMediaConstraints(const WebMediaConstraints& other) { assign(other); }
  63     ~WebMediaConstraints() { reset(); }
  64
  65     WebMediaConstraints& operator=(const WebMediaConstraints& other)
  66     {
  67         assign(other);
  68         return *this;
  69     }
  70
  71     BLINK_PLATFORM_EXPORT void assign(const WebMediaConstraints&);
  72
  73     BLINK_PLATFORM_EXPORT void reset();
  74     bool isNull() const { return m_private.isNull(); }
  75
  76     BLINK_PLATFORM_EXPORT void getOptionalConstraints(WebVector<WebMediaConstraint>&) const;
  77     BLINK_PLATFORM_EXPORT void getMandatoryConstraints(WebVector<WebMediaConstraint>&) const;
  78
  79     BLINK_PLATFORM_EXPORT bool getOptionalConstraintValue(const WebString& name, WebString& value) const;
  80     BLINK_PLATFORM_EXPORT bool getMandatoryConstraintValue(const WebString& name, WebString& value) const;
  81
  82     BLINK_PLATFORM_EXPORT void initialize();
  83     BLINK_PLATFORM_EXPORT void initialize(const WebVector<WebMediaConstraint>& optional, const WebVector<WebMediaConstraint>& mandatory);
  84
  85 private:
  86     WebPrivatePtr<WebMediaConstraintsPrivate> m_private;
  87 };
  88
  89 } // namespace blink
  90
  91 #endif // WebMediaConstraints_h