Agora C++ API Reference for All Platforms
screen_capture_i.h
1 //
2 // Agora Media SDK
3 //
4 // Created by Sting Feng in 2015-05.
5 // Copyright (c) 2015 Agora IO. All rights reserved.
6 //
7 #pragma once
8 
9 #include "NGIAgoraExtensionScreenSource.h"
10 #include "NGIAgoraScreenCapturer.h"
11 #include "api/video/video_content_type.h"
12 #include "api/video/video_frame.h"
13 #include "api/video/video_sink_interface.h"
14 #include "modules/desktop_capture/desktop_capturer.h"
15 
16 namespace agora {
17 namespace rtc {
18 
19 class IScreenCaptureObserver;
20 
22 public:
26  };
27  public:
28  virtual ~IScreenCapturerEx() {}
29  virtual int StartCapture() = 0;
30  virtual int StopCapture() = 0;
32  std::weak_ptr<::rtc::VideoSinkInterface<webrtc::VideoFrame>> dataCallback) = 0;
33  virtual int CaptureMouseCursor(bool capture) = 0;
34  virtual int GetScreenDimensions(VideoDimensions& dimension) = 0;
35  virtual int SetOutputDimensions(VideoDimensions dimension) {return 0;};
36  virtual int SetContentType(agora::VideoContentSubType type) {return 0;};
37  virtual bool FocusOnSelectedSource() = 0;
38  virtual void SetHighLight(bool isHighLight, unsigned int color, int width) {}
39  virtual void SetVideoQoEPusher(std::weak_ptr<agora::rtc::VideoStatsEventsPusher> pusher) = 0;
40 
41 #if defined(_WIN32)
42  virtual int InitUsingLastRegionSetting() { return -ERR_NOT_SUPPORTED; }
43  virtual void SetCaptureSource(bool allow_magnification_api, bool allow_directx_capturer) {}
44  virtual void GetCaptureSource(bool& allow_magnification_api, bool& allow_directx_capturer) {}
45  virtual void SetAllowUseWGC(bool allow_use_wgc) {}
46  virtual void GetAllowUseWGC(bool& allow_use_wgc) {}
47  virtual void SetCaptureToTexture(bool capture_to_texture) {}
48  virtual void GetCaptureToTexture(bool& capture_to_texture) {}
49 #endif // _WIN32
50 
51 #if defined(_WIN32) || (defined(WEBRTC_MAC) && !defined(WEBRTC_IOS))
52  virtual void ForcedUsingScreenCapture(bool using_screen_capture) {}
53 
54  virtual void SetExcludeWindowList(const std::vector<void *>& window_list) = 0;
55  virtual webrtc::DesktopCapturer::SourceId GetSourceId() = 0;
56  virtual int GetCaptureType() = 0;
57 #endif // _WIN32 || (WEBRTC_MAC&&!WEBRTC_IOS)
59  return -ERR_NOT_SUPPORTED;
60  }
62  return -ERR_NOT_SUPPORTED;
63  }
65  return nullptr;
66  }
67  virtual void deinit() {};
68  virtual void attachStatsSpace(uint64_t stats_space) {}
69 };
70 
72 public:
74  (void) state;
75  }
76 protected:
78 };
79 
80 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
81 class AudioPcmDataSinkInterface;
83  public:
84  virtual int startVideoCapture() = 0;
85  virtual int stopVideoCapture() = 0;
86  virtual int startAudioCapture() = 0;
87  virtual int stopAudioCapture() = 0;
88  virtual void addPcmDataSink(AudioPcmDataSinkInterface* sink) = 0;
89  virtual void removePcmDataSink(AudioPcmDataSinkInterface* sink) = 0;
90  virtual void deinit() {};
91  virtual void attachStatsSpace(uint64_t stats_space) {}
92  virtual void SetVideoQoEPusher(std::weak_ptr<agora::rtc::VideoStatsEventsPusher> pusher) = 0;
93 };
94 #endif
95 
96 } // namespace rtc
97 } // namespace agora
agora::rtc::IScreenCapturerEx::InitUsingLastRegionSetting
virtual int InitUsingLastRegionSetting()
Definition: screen_capture_i.h:42
agora::rtc::IScreenCapturerEx::GetAllowUseWGC
virtual void GetAllowUseWGC(bool &allow_use_wgc)
Definition: screen_capture_i.h:46
agora::rtc::IScreenCapturerEx::GetCaptureType
virtual int GetCaptureType()=0
agora::rtc::IScreenCapturerEx::ForcedUsingScreenCapture
virtual void ForcedUsingScreenCapture(bool using_screen_capture)
Definition: screen_capture_i.h:52
agora::rtc::IScreenCaptureObserver
Definition: screen_capture_i.h:71
agora::rtc::IScreenCaptureObserver::onScreenCaptureStateChanged
virtual void onScreenCaptureStateChanged(IScreenCapturerEx::SCREEN_CAPTURER_STATE state)
Definition: screen_capture_i.h:73
agora::rtc::IScreenCapturerEx::SetHighLight
virtual void SetHighLight(bool isHighLight, unsigned int color, int width)
Definition: screen_capture_i.h:38
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STATE
SCREEN_CAPTURER_STATE
Definition: screen_capture_i.h:23
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STOPPED
@ SCREEN_CAPTURER_STOPPED
Definition: screen_capture_i.h:25
agora::rtc::IScreenCapturerEx::SetExcludeWindowList
virtual void SetExcludeWindowList(const std::vector< void * > &window_list)=0
agora::rtc::IScreenCapturerEx::SetOutputDimensions
virtual int SetOutputDimensions(VideoDimensions dimension)
Definition: screen_capture_i.h:35
agora::rtc::IScreenCapturerEx::RegisterCaptureDataCallback
virtual void RegisterCaptureDataCallback(std::weak_ptr<::rtc::VideoSinkInterface< webrtc::VideoFrame >> dataCallback)=0
agora::rtc::IScreenCapturerEx::unregisterScreenCaptureObserver
virtual int unregisterScreenCaptureObserver(IScreenCaptureObserver *observer)
Definition: screen_capture_i.h:61
agora::rtc::IScreenCapturerEx::deinit
virtual void deinit()
Definition: screen_capture_i.h:67
agora::rtc::IScreenCapturerEx::FocusOnSelectedSource
virtual bool FocusOnSelectedSource()=0
agora::rtc::IScreenCapturerEx2::SetVideoQoEPusher
virtual void SetVideoQoEPusher(std::weak_ptr< agora::rtc::VideoStatsEventsPusher > pusher)=0
agora::rtc::IScreenCapturerEx::registerScreenCaptureObserver
virtual int registerScreenCaptureObserver(IScreenCaptureObserver *observer)
Definition: screen_capture_i.h:58
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IScreenCaptureSource::ScreenSourceListOption
Definition: NGIAgoraExtensionScreenSource.h:87
agora::rtc::IScreenCapturer
Definition: NGIAgoraScreenCapturer.h:18
agora::rtc::IScreenCaptureObserver::~IScreenCaptureObserver
virtual ~IScreenCaptureObserver()
Definition: screen_capture_i.h:77
agora::rtc::IScreenCapturerEx::CaptureMouseCursor
virtual int CaptureMouseCursor(bool capture)=0
agora::rtc::IScreenCapturerEx2::removePcmDataSink
virtual void removePcmDataSink(AudioPcmDataSinkInterface *sink)=0
agora::rtc::IScreenCapturerEx::StopCapture
virtual int StopCapture()=0
agora::rtc::IScreenCapturerEx::GetCaptureSource
virtual void GetCaptureSource(bool &allow_magnification_api, bool &allow_directx_capturer)
Definition: screen_capture_i.h:44
agora::rtc::IScreenCapturerEx::SetCaptureToTexture
virtual void SetCaptureToTexture(bool capture_to_texture)
Definition: screen_capture_i.h:47
agora::rtc::IScreenCapturerEx::getScreenCaptureSources
virtual void * getScreenCaptureSources(const IScreenCaptureSource::ScreenSourceListOption &option)
Definition: screen_capture_i.h:64
agora::rtc::IScreenCapturerEx::SetVideoQoEPusher
virtual void SetVideoQoEPusher(std::weak_ptr< agora::rtc::VideoStatsEventsPusher > pusher)=0
agora::rtc::IScreenCapturerEx::SetCaptureSource
virtual void SetCaptureSource(bool allow_magnification_api, bool allow_directx_capturer)
Definition: screen_capture_i.h:43
agora::rtc::IScreenCapturerEx2::startAudioCapture
virtual int startAudioCapture()=0
agora::rtc::IScreenCapturer2
Definition: NGIAgoraScreenCapturer.h:145
agora::ERR_NOT_SUPPORTED
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:466
agora::rtc::IScreenCapturerEx2::deinit
virtual void deinit()
Definition: screen_capture_i.h:90
agora::rtc::IScreenCapturerEx::GetCaptureToTexture
virtual void GetCaptureToTexture(bool &capture_to_texture)
Definition: screen_capture_i.h:48
agora::rtc::IScreenCapturerEx::GetScreenDimensions
virtual int GetScreenDimensions(VideoDimensions &dimension)=0
agora::rtc::IScreenCapturerEx2::stopAudioCapture
virtual int stopAudioCapture()=0
agora::rtc::IScreenCapturerEx2
Definition: screen_capture_i.h:82
agora::rtc::IScreenCapturerEx::GetSourceId
virtual webrtc::DesktopCapturer::SourceId GetSourceId()=0
agora::rtc::IScreenCapturerEx::SetContentType
virtual int SetContentType(agora::VideoContentSubType type)
Definition: screen_capture_i.h:36
agora::rtc::IScreenCapturerEx2::stopVideoCapture
virtual int stopVideoCapture()=0
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STARTED
@ SCREEN_CAPTURER_STARTED
Definition: screen_capture_i.h:24
agora::rtc::IScreenCapturerEx
Definition: screen_capture_i.h:21
agora::rtc::IScreenCapturerEx::~IScreenCapturerEx
virtual ~IScreenCapturerEx()
Definition: screen_capture_i.h:28
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1075
agora::rtc::IScreenCapturerEx::attachStatsSpace
virtual void attachStatsSpace(uint64_t stats_space)
Definition: screen_capture_i.h:68
agora::rtc::IScreenCapturerEx2::attachStatsSpace
virtual void attachStatsSpace(uint64_t stats_space)
Definition: screen_capture_i.h:91
agora::rtc::IScreenCapturerEx2::addPcmDataSink
virtual void addPcmDataSink(AudioPcmDataSinkInterface *sink)=0
agora::rtc::IScreenCapturerEx::SetAllowUseWGC
virtual void SetAllowUseWGC(bool allow_use_wgc)
Definition: screen_capture_i.h:45
rtc::VideoSinkInterface
Definition: video_node_i.h:30
agora::rtc::IScreenCapturerEx2::startVideoCapture
virtual int startVideoCapture()=0
rtc
Definition: video_node_i.h:26
agora::rtc::IScreenCapturerEx::StartCapture
virtual int StartCapture()=0