File: media_item_ui_helper.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (123 lines) | stat: -rw-r--r-- 4,532 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_VIEWS_GLOBAL_MEDIA_CONTROLS_MEDIA_ITEM_UI_HELPER_H_
#define CHROME_BROWSER_UI_VIEWS_GLOBAL_MEDIA_CONTROLS_MEDIA_ITEM_UI_HELPER_H_

#include <memory>
#include <optional>
#include <string>

#include "base/memory/weak_ptr.h"
#include "components/global_media_controls/public/constants.h"
#include "components/global_media_controls/public/mojom/device_service.mojom.h"
#include "components/media_message_center/notification_theme.h"

class MediaItemUIDeviceSelectorDelegate;
class Profile;

namespace content {
class BrowserContext;
}  // namespace content

namespace gfx {
struct VectorIcon;
}  // namespace gfx

namespace global_media_controls {
class MediaItemUIDeviceSelector;
class MediaItemUIFooter;
}  // namespace global_media_controls

namespace global_media_controls::mojom {
class DeviceService;
}  // namespace global_media_controls::mojom

namespace media_message_center {
class MediaNotificationItem;
}  // namespace media_message_center

namespace media_router {
class MediaRoute;
}  // namespace media_router

// A set of the pending remote of `DeviceListHost` and the pending receiver of
// `DeviceListClient`.
struct HostAndClientPair {
  HostAndClientPair();
  HostAndClientPair(HostAndClientPair&&);
  HostAndClientPair& operator=(HostAndClientPair&&);
  ~HostAndClientPair();

  mojo::PendingRemote<global_media_controls::mojom::DeviceListHost> host;
  mojo::PendingReceiver<global_media_controls::mojom::DeviceListClient> client;
};

// These helper functions are shared among Chrome OS and other desktop
// platforms.

// Checks if we should show the device selector view (cast device list) under
// the media ui view. Returns false if any of `device_service`,
// `selector_delegate`, `profile`, `item` is null.
bool ShouldShowDeviceSelectorView(
    Profile* profile,
    global_media_controls::mojom::DeviceService* device_service,
    const std::string& item_id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item,
    MediaItemUIDeviceSelectorDelegate* selector_delegate);

// Creates and returns a `HostAndClientPair`.
HostAndClientPair CreateHostAndClient(
    Profile* profile,
    const std::string& id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item,
    global_media_controls::mojom::DeviceService* device_service);

// Returns the stop casting callback if it's casting.
base::RepeatingClosure GetStopCastingCallback(
    Profile* profile,
    const std::string& id,
    const base::WeakPtr<media_message_center::MediaNotificationItem>& item);

// Returns whether `item` has an associated Remote Playback route.
bool HasRemotePlaybackRoute(
    base::WeakPtr<media_message_center::MediaNotificationItem> item);

// Returns the MediaRoute associated with `item`, if one exists.
std::optional<media_router::MediaRoute> GetSessionRoute(
    const std::string& item_id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    content::BrowserContext* context);

// Returns the MediaItemUIDeviceSelector for a media item or returns a nullptr
// if any of the parameters is invalid.
std::unique_ptr<global_media_controls::MediaItemUIDeviceSelector>
BuildDeviceSelector(
    const std::string& id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    global_media_controls::mojom::DeviceService* device_service,
    MediaItemUIDeviceSelectorDelegate* selector_delegate,
    Profile* profile,
    global_media_controls::GlobalMediaControlsEntryPoint entry_point,
    bool show_devices = false,
    std::optional<media_message_center::MediaColorTheme> media_color_theme =
        std::nullopt);

// Returns the MediaItemUIFooter for Cast items or Media Session items with
// associated Media Routes.
std::unique_ptr<global_media_controls::MediaItemUIFooter> BuildFooter(
    const std::string& id,
    base::WeakPtr<media_message_center::MediaNotificationItem> item,
    Profile* profile,
    std::optional<media_message_center::MediaColorTheme> media_color_theme =
        std::nullopt);

// Returns the MediaColorTheme for the updated media UI.
media_message_center::MediaColorTheme GetMediaColorTheme();

// Return the vector icon for display for the given cast device icon type.
const gfx::VectorIcon& GetVectorIcon(
    global_media_controls::mojom::IconType icon);

#endif  // CHROME_BROWSER_UI_VIEWS_GLOBAL_MEDIA_CONTROLS_MEDIA_ITEM_UI_HELPER_H_