third_party/WebKit/public/web/WebUserMediaRequest.h

   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 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 WebUserMediaRequest_h
  32 #define WebUserMediaRequest_h
  33
  34 #include "public/platform/WebCommon.h"
  35 #include "public/platform/WebPrivatePtr.h"
  36 #include "public/platform/WebSecurityOrigin.h"
  37 #include "public/platform/WebString.h"
  38
  39 namespace blink {
  40
  41 class UserMediaRequest;
  42 class WebDocument;
  43 class WebMediaConstraints;
  44 class WebMediaStream;
  45
  46 class WebUserMediaRequest {
  47 public:
  48     WebUserMediaRequest() { }
  49     WebUserMediaRequest(const WebUserMediaRequest& request) { assign(request); }
  50     ~WebUserMediaRequest() { reset(); }
  51
  52     WebUserMediaRequest& operator=(const WebUserMediaRequest& other)
  53     {
  54         assign(other);
  55         return *this;
  56     }
  57
  58     BLINK_EXPORT void reset();
  59     bool isNull() const { return m_private.isNull(); }
  60     BLINK_EXPORT bool equals(const WebUserMediaRequest&) const;
  61     BLINK_EXPORT void assign(const WebUserMediaRequest&);
  62
  63     BLINK_EXPORT bool audio() const;
  64     BLINK_EXPORT bool video() const;
  65     BLINK_EXPORT WebMediaConstraints audioConstraints() const;
  66     BLINK_EXPORT WebMediaConstraints videoConstraints() const;
  67
  68     BLINK_EXPORT WebSecurityOrigin securityOrigin() const;
  69     BLINK_EXPORT WebDocument ownerDocument() const;
  70
  71     BLINK_EXPORT void requestSucceeded(const WebMediaStream&);
  72
  73     BLINK_EXPORT void requestDenied(const WebString& description = WebString());
  74     BLINK_EXPORT void requestFailedConstraint(const WebString& constraintName, const WebString& description = WebString());
  75     BLINK_EXPORT void requestFailedUASpecific(const WebString& name, const WebString& constraintName = WebString(), const WebString& description = WebString());
  76
  77     // DEPRECATED
  78     BLINK_EXPORT void requestFailed(const WebString& description = WebString()) { requestDenied(description); }
  79
  80 #if BLINK_IMPLEMENTATION
  81     WebUserMediaRequest(UserMediaRequest*);
  82     operator UserMediaRequest*() const;
  83 #endif
  84
  85 private:
  86     WebPrivatePtr<UserMediaRequest> m_private;
  87 };
  88
  89 inline bool operator==(const WebUserMediaRequest& a, const WebUserMediaRequest& b)
  90 {
  91     return a.equals(b);
  92 }
  93
  94 } // namespace blink
  95
  96 #endif // WebUserMediaRequest_h