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
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_CONTENT_CAPTURE_BROWSER_CONTENT_CAPTURE_CONSUMER_H_
#define COMPONENTS_CONTENT_CAPTURE_BROWSER_CONTENT_CAPTURE_CONSUMER_H_
#include <vector>
#include "components/content_capture/browser/content_capture_frame.h"
class GURL;
namespace content_capture {
// The interface for the embedder to get onscreen content.
//
// The embedder shall call OnscreenContentProvider::AddConsumer() to add
// itself as consumer.
//
// OnscreenContentProvider* provider =
// OnscreenContentProvider::FromWebContents(web_contents);
// if (!provider)
// provider = OnscreenContentProvider::Create(web_contents);
// provider->AddConsumer(*this);
//
// The embedder might remove itself when the onscreen content is no longer
// needed.
// // Keep the weak reference
// onscreen_content_provider_ = provider->GetWeakPtr();
//
// // Remove from the consumers
// if (auto* provider = onscreen_content_provider_.get())
// provider->RemoveConsumer(*this);
class ContentCaptureConsumer {
public:
virtual ~ContentCaptureConsumer() = default;
// Invoked to notify that a batch of Content Capture has ended.
virtual void FlushCaptureContent(const ContentCaptureSession& session,
const ContentCaptureFrame& data) = 0;
// Invoked when the captured content |data| from the |parent_session| was
// received.
virtual void DidCaptureContent(const ContentCaptureSession& parent_session,
const ContentCaptureFrame& data) = 0;
// Invoked when the updated content |data| from the |parent_session| was
// received.
virtual void DidUpdateContent(const ContentCaptureSession& parent_session,
const ContentCaptureFrame& data) = 0;
// Invoked when the list of content |ids| of the given |session| was removed.
virtual void DidRemoveContent(const ContentCaptureSession& session,
const std::vector<int64_t>& ids) = 0;
// Invoked when the given |session| was removed because
// - the corresponding frame is deleted,
// - or the corresponding WebContents is deleted.
// - or the consumer removes itself from OnscreenContentProvider, only
// main session will be notified in this case.
virtual void DidRemoveSession(const ContentCaptureSession& session) = 0;
// Invoked when the given |main_frame|'s title updated.
virtual void DidUpdateTitle(const ContentCaptureFrame& main_frame) = 0;
// Invoked when the given |main_frame|'s favicon updated.
virtual void DidUpdateFavicon(const ContentCaptureFrame& main_frame) = 0;
// Return if the |url| shall be captured. Even return false, the content might
// still be streamed because of the other consumers require it. Consumer can
// ignore the content upon it arrives.
virtual bool ShouldCapture(const GURL& url) = 0;
};
} // namespace content_capture
#endif // COMPONENTS_CONTENT_CAPTURE_BROWSER_CONTENT_CAPTURE_CONSUMER_H_
|
