summaryrefslogtreecommitdiff
path: root/chromium/chrome/browser/media/webrtc/desktop_media_picker.h
diff options
context:
space:
mode:
Diffstat (limited to 'chromium/chrome/browser/media/webrtc/desktop_media_picker.h')
-rw-r--r--chromium/chrome/browser/media/webrtc/desktop_media_picker.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/chromium/chrome/browser/media/webrtc/desktop_media_picker.h b/chromium/chrome/browser/media/webrtc/desktop_media_picker.h
new file mode 100644
index 00000000000..afcb60351dd
--- /dev/null
+++ b/chromium/chrome/browser/media/webrtc/desktop_media_picker.h
@@ -0,0 +1,88 @@
+// Copyright 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_MEDIA_WEBRTC_DESKTOP_MEDIA_PICKER_H_
+#define CHROME_BROWSER_MEDIA_WEBRTC_DESKTOP_MEDIA_PICKER_H_
+
+#include <memory>
+#include <string>
+#include <utility>
+
+#include "base/callback_forward.h"
+#include "base/macros.h"
+#include "base/memory/ref_counted.h"
+#include "base/optional.h"
+#include "base/strings/string16.h"
+#include "content/public/browser/desktop_media_id.h"
+#include "content/public/browser/web_contents_observer.h"
+#include "ui/base/ui_base_types.h"
+#include "ui/gfx/native_widget_types.h"
+
+class DesktopMediaList;
+
+namespace content {
+class WebContents;
+}
+
+// Abstract interface for desktop media picker UI. It's used by Desktop Media
+// API and by ARC to let user choose a desktop media source.
+//
+// TODO(crbug.com/987001): Rename this class.
+class DesktopMediaPicker {
+ public:
+ using DoneCallback = base::OnceCallback<void(content::DesktopMediaID id)>;
+
+ struct Params {
+ Params();
+ ~Params();
+
+ // WebContents this picker is relative to, can be null.
+ content::WebContents* web_contents = nullptr;
+ // The context whose root window is used for dialog placement, cannot be
+ // null for Aura.
+ gfx::NativeWindow context = nullptr;
+ // Parent window the dialog is relative to, only used on Mac.
+ gfx::NativeWindow parent = nullptr;
+ // The modality used for showing the dialog.
+ ui::ModalType modality = ui::ModalType::MODAL_TYPE_CHILD;
+ // The name used in the dialog for what is requesting the picker to be
+ // shown.
+ base::string16 app_name;
+ // Can be the same as target_name. If it is not then this is used in the
+ // dialog for what is specific target within the app_name is requesting the
+ // picker.
+ base::string16 target_name;
+ // Whether audio capture should be shown as an option in the picker.
+ bool request_audio = false;
+ // Whether audio capture option should be approved by default if shown.
+ bool approve_audio_by_default = true;
+ // This flag controls the behvior in the case where the picker is invoked to
+ // select a screen and there is only one screen available. If true, the
+ // dialog is bypassed entirely and the screen is automatically selected.
+ // This behavior is disabled by default because in addition to letting the
+ // user select a desktop, the desktop picker also serves to prevent the
+ // screen screen from being shared without the user's explicit consent.
+ bool select_only_screen = false;
+ };
+
+ // Creates default implementation of DesktopMediaPicker for the current
+ // platform.
+ static std::unique_ptr<DesktopMediaPicker> Create();
+
+ DesktopMediaPicker() {}
+ virtual ~DesktopMediaPicker() {}
+
+ // Shows dialog with list of desktop media sources (screens, windows, tabs)
+ // provided by |sources_lists|.
+ // Dialog window will call |done_callback| when user chooses one of the
+ // sources or closes the dialog.
+ virtual void Show(const Params& params,
+ std::vector<std::unique_ptr<DesktopMediaList>> source_lists,
+ DoneCallback done_callback) = 0;
+
+ private:
+ DISALLOW_COPY_AND_ASSIGN(DesktopMediaPicker);
+};
+
+#endif // CHROME_BROWSER_MEDIA_WEBRTC_DESKTOP_MEDIA_PICKER_H_