File: media_session_player_observer.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 6,122,156 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (120 lines) | stat: -rw-r--r-- 4,534 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
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_PLAYER_OBSERVER_H_
#define CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_PLAYER_OBSERVER_H_

#include <optional>

#include "base/functional/callback.h"
#include "base/time/time.h"
#include "media/base/picture_in_picture_events_info.h"

namespace media {
enum class MediaContentType;
}

namespace media_session {
struct MediaPosition;
}  // namespace media_session

namespace content {

class RenderFrameHost;

class MediaSessionPlayerObserver {
 public:
  MediaSessionPlayerObserver() = default;
  virtual ~MediaSessionPlayerObserver() = default;

  // The given |player_id| has been suspended by the MediaSession.
  virtual void OnSuspend(int player_id) = 0;

  // The given |player_id| has been resumed by the MediaSession.
  virtual void OnResume(int player_id) = 0;

  // The given |player_id| has been seeked forward by the MediaSession.
  virtual void OnSeekForward(int player_id, base::TimeDelta seek_time) = 0;

  // The given |player_id| has been seeked backward by the MediaSession.
  virtual void OnSeekBackward(int player_id, base::TimeDelta seek_time) = 0;

  // The given |player_id| has been seeked to by the MediaSession.
  virtual void OnSeekTo(int player_id, base::TimeDelta seek_time) = 0;

  // The given |player_id| has been set a new volume multiplier by
  // the MediaSession.
  virtual void OnSetVolumeMultiplier(int player_id,
                                     double volume_multiplier) = 0;

  // The given |player_id| has been requested picture-in-picture.
  virtual void OnEnterPictureInPicture(int player_id) = 0;

  // The given |player_id| has been requested to route audio output to the
  // specified audio device.
  virtual void OnSetAudioSinkId(int player_id,
                                const std::string& raw_device_id) = 0;

  // The given |player_id| has been requested to mute or unmute.
  virtual void OnSetMute(int player_id, bool mute) = 0;

  // The given |player_id| has been requested to start Media Remoting.
  virtual void OnRequestMediaRemoting(int player_id) = 0;

  // `RequestVisibilityCallback` is used to enable computing video visibility
  // on-demand. The callback is passed to the MediaVideoVisibilityTracker, where
  // the on-demand visibility computation will take place.
  //
  // The boolean parameter represents whether a video element meets a given
  // visibility threshold. This threshold (`kVisibilityThreshold`) is defined by
  // the HTMLVideoElement.
  using RequestVisibilityCallback = base::OnceCallback<void(bool)>;

  // The given |player_id| has been requested to report its video visibility.
  virtual void OnRequestVisibility(
      int player_id,
      RequestVisibilityCallback request_visibility_callback) = 0;

  // Returns the position for |player_id|.
  virtual std::optional<media_session::MediaPosition> GetPosition(
      int player_id) const = 0;

  // Returns if picture-in-picture is available for |player_id|.
  virtual bool IsPictureInPictureAvailable(int player_id) const = 0;

  // Returns if player's |player_id| video is sufficiently visible.
  virtual bool HasSufficientlyVisibleVideo(int player_id) const = 0;

  // Returns true if the |player_id| has audio tracks.
  virtual bool HasAudio(int player_id) const = 0;

  // Returns true if the |player_id| has video tracks.
  virtual bool HasVideo(int player_id) const = 0;

  // Returns true if `player_id` is paused.
  virtual bool IsPaused(int player_id) const = 0;

  // Returns the id of the audio output device used by |player_id|. Returns the
  // empty string if unavailable.
  virtual std::string GetAudioOutputSinkId(int player_id) const = 0;

  // Returns true if the |player_id| supports audio output device switching.
  virtual bool SupportsAudioOutputDeviceSwitching(int player_id) const = 0;

  virtual media::MediaContentType GetMediaContentType() const = 0;

  // Called when the auto picture in picture information has changed.
  virtual void OnAutoPictureInPictureInfoChanged(
      int player_id,
      const media::PictureInPictureEventsInfo::AutoPipInfo&
          auto_picture_in_picture_info) = 0;

  // Returns the RenderFrameHost this player observer belongs to. Returns
  // nullptr if unavailable.
  virtual RenderFrameHost* render_frame_host() const = 0;
};

}  // namespace content

#endif  // CONTENT_BROWSER_MEDIA_SESSION_MEDIA_SESSION_PLAYER_OBSERVER_H_