third_party/blink/public/web/web_user_media_request.h

/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_USER_MEDIA_REQUEST_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_USER_MEDIA_REQUEST_H_

#include "third_party/blink/public/platform/web_common.h"
#include "third_party/blink/public/platform/web_private_ptr.h"
#include "third_party/blink/public/platform/web_security_origin.h"
#include "third_party/blink/public/platform/web_string.h"

namespace blink {

class UserMediaRequest;
class WebDocument;
class WebMediaConstraints;
class WebMediaStream;

class BLINK_EXPORT WebUserMediaRequest {
 public:
  enum class Error {
    kNotSupported,
    kSecurityError,
    kPermissionDenied,
    kPermissionDismissed,
    kInvalidState,
    kDevicesNotFound,
    kTabCapture,
    kScreenCapture,
    kCapture,
    kTrackStart,
    kFailedDueToShutdown,
    kKillSwitchOn
  };

  enum class MediaType {
    kUserMedia,
    kDisplayMedia,
  };

  WebUserMediaRequest() = default;
  WebUserMediaRequest(const WebUserMediaRequest& request) { Assign(request); }
  ~WebUserMediaRequest() { Reset(); }

  WebUserMediaRequest& operator=(const WebUserMediaRequest& other) {
    Assign(other);
    return *this;
  }

  void Reset();
  bool IsNull() const { return private_.IsNull(); }
  bool Equals(const WebUserMediaRequest&) const;
  void Assign(const WebUserMediaRequest&);

  MediaType MediaRequestType() const;
  bool Audio() const;
  bool Video() const;
  WebMediaConstraints AudioConstraints() const;
  WebMediaConstraints VideoConstraints() const;

  // Flag tied to whether or not the similarly named Origin Trial is
  // enabled. Will be removed at end of trial. See: http://crbug.com/789152.
  bool ShouldDisableHardwareNoiseSuppression() const;

  WebSecurityOrigin GetSecurityOrigin() const;
  WebDocument OwnerDocument() const;

  void RequestSucceeded(const WebMediaStream&);

  void RequestFailedConstraint(const WebString& constraint_name,
                               const WebString& description = WebString());
  void RequestFailed(Error name, const WebString& description = WebString());

  // For testing in content/
  static WebUserMediaRequest CreateForTesting(const WebMediaConstraints& audio,
                                              const WebMediaConstraints& video);

#if INSIDE_BLINK
  WebUserMediaRequest(UserMediaRequest*);
  operator UserMediaRequest*() const;
#endif

 private:
  WebPrivatePtr<UserMediaRequest> private_;
};

inline bool operator==(const WebUserMediaRequest& a,
                       const WebUserMediaRequest& b) {
  return a.Equals(b);
}

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_USER_MEDIA_REQUEST_H_