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 "AgoraRefPtr.h"
10 #include "NGIAgoraExtensionScreenSource.h"
11 #include "NGIAgoraScreenCapturer.h"
12 #include "api/video/video_content_type.h"
13 #include "api/video/video_frame.h"
14 #include "api/video/video_sink_interface.h"
15 #include "modules/desktop_capture/desktop_capturer.h"
16 
17 namespace agora {
18 namespace rtc {
19 
20 class IScreenCaptureObserver;
21 
23 public:
27  };
28  public:
29  virtual ~IScreenCapturerEx() {}
30  virtual int StartCapture() = 0;
31  virtual int StopCapture() = 0;
33  std::weak_ptr<::rtc::VideoSinkInterface<webrtc::VideoFrame>> dataCallback) = 0;
34  virtual int CaptureMouseCursor(bool capture) = 0;
35  virtual int GetScreenDimensions(VideoDimensions& dimension) = 0;
36  virtual int SetOutputDimensions(VideoDimensions dimension) {return 0;};
37  virtual int SetContentType(agora::VideoContentSubType type) {return 0;};
38  virtual void GetContentType(agora::VideoContentType& type, agora::VideoContentSubType& subtype) {};
39  virtual bool FocusOnSelectedSource() = 0;
40  virtual void SetHighLight(bool isHighLight, unsigned int color, int width) {}
41  virtual void SetVideoQoEPusher(std::weak_ptr<agora::rtc::VideoStatsEventsPusher> pusher) = 0;
42 
43 #if defined(_WIN32) || (defined(__APPLE__) && !TARGET_OS_IPHONE && TARGET_OS_MAC)
44  virtual int initWithDisplayIdLLApiInternal(uint32_t displayId, const rtc::Rectangle& regionRect) = 0;
45 #endif
46 
47 #if defined(_WIN32) || (defined(__linux__) && !defined(__ANDROID__))
48  virtual int initWithScreenRectLLApiInternal(const rtc::Rectangle& screenRect, const rtc::Rectangle& regionRect) = 0;
49 #endif
50  virtual int initWithWindowIdLLApiInternal(view_t windowId, const rtc::Rectangle& regionRect) = 0;
53  virtual int setFrameRateLLApiInternal(int rate) = 0;
54 #if defined(__ANDROID__)
55  virtual int initWithMediaProjectionPermissionResultDataLLApiInternal(void* data, const VideoDimensions& dimensions) = 0;
56 #endif
57 #if defined(_WIN32)
58  virtual int InitUsingLastRegionSetting() { return -ERR_NOT_SUPPORTED; }
59  virtual void SetCaptureSource(bool allow_magnification_api, bool allow_directx_capturer) {}
60  virtual void GetCaptureSource(bool& allow_magnification_api, bool& allow_directx_capturer) {}
61  virtual void SetAllowUseWGC(bool allow_use_wgc) {}
62  virtual void GetAllowUseWGC(bool& allow_use_wgc) {}
63  virtual void SetCaptureToTexture(bool capture_to_texture) {}
64  virtual void GetCaptureToTexture(bool& capture_to_texture) {}
65 #endif // _WIN32
66 
67 #if defined(_WIN32) || (defined(WEBRTC_MAC) && !defined(WEBRTC_IOS))
68  virtual void ForcedUsingScreenCapture(bool using_screen_capture) {}
69 
70  virtual void SetExcludeWindowList(const std::vector<void *>& window_list) = 0;
71  virtual webrtc::DesktopCapturer::SourceId GetSourceId() = 0;
72  virtual int GetCaptureType() = 0;
73 #endif // _WIN32 || (WEBRTC_MAC&&!WEBRTC_IOS)
75  return -ERR_NOT_SUPPORTED;
76  }
78  return -ERR_NOT_SUPPORTED;
79  }
81  return nullptr;
82  }
83  virtual void deinit() {};
84  virtual void attachStatsSpace(uint64_t stats_space) {}
85 };
86 
88 public:
90  (void) state;
91  }
92 protected:
94 };
95 
96 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
97 class AudioPcmDataSinkInterface;
99  public:
100  virtual int startVideoCapture() = 0;
101  virtual int stopVideoCapture() = 0;
102  virtual int startAudioCapture() = 0;
103  virtual int stopAudioCapture() = 0;
104  virtual void addPcmDataSink(AudioPcmDataSinkInterface* sink) = 0;
105  virtual void removePcmDataSink(AudioPcmDataSinkInterface* sink) = 0;
106  virtual void deinit() {};
107  virtual void attachStatsSpace(uint64_t stats_space) {}
108  virtual void SetVideoQoEPusher(std::weak_ptr<agora::rtc::VideoStatsEventsPusher> pusher) = 0;
109  virtual int setScreenCaptureDimensionsLLApiInternal(const VideoDimensions& dimensions) = 0;
110  virtual int updateScreenCaptureRegionLLApiInternal(const rtc::Rectangle& regionRect) = 0;
111  virtual int setFrameRateLLApiInternal(int fps) = 0;
112  virtual int setAudioRecordConfigLLApiInternal(int channels, int sampleRate) = 0;
113  virtual int setAudioVolumeLLApiInternal(uint32_t volume) = 0;
114 };
115 #endif
116 
117 } // namespace rtc
118 } // namespace agora
agora::rtc::IScreenCapturerEx::InitUsingLastRegionSetting
virtual int InitUsingLastRegionSetting()
Definition: screen_capture_i.h:58
agora::rtc::IScreenCapturerEx::GetContentType
virtual void GetContentType(agora::VideoContentType &type, agora::VideoContentSubType &subtype)
Definition: screen_capture_i.h:38
agora::rtc::IScreenCapturerEx::setFrameRateLLApiInternal
virtual int setFrameRateLLApiInternal(int rate)=0
agora::rtc::IScreenCapturerEx::GetAllowUseWGC
virtual void GetAllowUseWGC(bool &allow_use_wgc)
Definition: screen_capture_i.h:62
agora::rtc::IScreenCapturerEx::initWithWindowIdLLApiInternal
virtual int initWithWindowIdLLApiInternal(view_t windowId, const rtc::Rectangle &regionRect)=0
agora::rtc::IScreenCapturerEx::GetCaptureType
virtual int GetCaptureType()=0
agora::rtc::IScreenCapturerEx::ForcedUsingScreenCapture
virtual void ForcedUsingScreenCapture(bool using_screen_capture)
Definition: screen_capture_i.h:68
agora::rtc::IScreenCaptureObserver
Definition: screen_capture_i.h:87
agora::rtc::IScreenCapturerEx::initWithDisplayIdLLApiInternal
virtual int initWithDisplayIdLLApiInternal(uint32_t displayId, const rtc::Rectangle &regionRect)=0
agora::rtc::IScreenCaptureObserver::onScreenCaptureStateChanged
virtual void onScreenCaptureStateChanged(IScreenCapturerEx::SCREEN_CAPTURER_STATE state)
Definition: screen_capture_i.h:89
agora::rtc::IScreenCapturerEx::SetHighLight
virtual void SetHighLight(bool isHighLight, unsigned int color, int width)
Definition: screen_capture_i.h:40
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STATE
SCREEN_CAPTURER_STATE
Definition: screen_capture_i.h:24
agora::rtc::Rectangle
Definition: AgoraBase.h:2164
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STOPPED
@ SCREEN_CAPTURER_STOPPED
Definition: screen_capture_i.h:26
agora::rtc::IScreenCapturerEx::SetExcludeWindowList
virtual void SetExcludeWindowList(const std::vector< void * > &window_list)=0
agora::view_t
void * view_t
Definition: AgoraBase.h:807
agora::rtc::IScreenCapturerEx::setScreenOrientationLLApiInternal
virtual int setScreenOrientationLLApiInternal(VIDEO_ORIENTATION orientation)=0
agora::rtc::IScreenCapturerEx::SetOutputDimensions
virtual int SetOutputDimensions(VideoDimensions dimension)
Definition: screen_capture_i.h:36
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:77
agora::rtc::IScreenCapturerEx::deinit
virtual void deinit()
Definition: screen_capture_i.h:83
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:74
agora::rtc::IScreenCapturerEx::updateScreenCaptureRegionLLApiInternal
virtual int updateScreenCaptureRegionLLApiInternal(const rtc::Rectangle &rect)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IScreenCaptureSource::ScreenSourceListOption
Definition: NGIAgoraExtensionScreenSource.h:94
agora::rtc::IScreenCapturerEx2::setAudioRecordConfigLLApiInternal
virtual int setAudioRecordConfigLLApiInternal(int channels, int sampleRate)=0
agora::rtc::IScreenCapturer
Definition: NGIAgoraScreenCapturer.h:19
agora::rtc::IScreenCaptureObserver::~IScreenCaptureObserver
virtual ~IScreenCaptureObserver()
Definition: screen_capture_i.h:93
agora::rtc::IScreenCapturerEx::CaptureMouseCursor
virtual int CaptureMouseCursor(bool capture)=0
agora::rtc::IScreenCapturerEx2::removePcmDataSink
virtual void removePcmDataSink(AudioPcmDataSinkInterface *sink)=0
agora::rtc::VIDEO_ORIENTATION
VIDEO_ORIENTATION
Definition: AgoraBase.h:940
agora::rtc::IScreenCapturerEx2::setFrameRateLLApiInternal
virtual int setFrameRateLLApiInternal(int fps)=0
agora::rtc::IScreenCapturerEx2::updateScreenCaptureRegionLLApiInternal
virtual int updateScreenCaptureRegionLLApiInternal(const rtc::Rectangle &regionRect)=0
agora::rtc::IScreenCapturerEx::StopCapture
virtual int StopCapture()=0
agora::rtc::IScreenCapturerEx::initWithMediaProjectionPermissionResultDataLLApiInternal
virtual int initWithMediaProjectionPermissionResultDataLLApiInternal(void *data, const VideoDimensions &dimensions)=0
agora::rtc::IScreenCapturerEx::GetCaptureSource
virtual void GetCaptureSource(bool &allow_magnification_api, bool &allow_directx_capturer)
Definition: screen_capture_i.h:60
agora::rtc::IScreenCapturerEx::SetCaptureToTexture
virtual void SetCaptureToTexture(bool capture_to_texture)
Definition: screen_capture_i.h:63
agora::rtc::IScreenCapturerEx::getScreenCaptureSources
virtual void * getScreenCaptureSources(const IScreenCaptureSource::ScreenSourceListOption &option)
Definition: screen_capture_i.h:80
agora::rtc::IScreenCapturerEx::initWithScreenRectLLApiInternal
virtual int initWithScreenRectLLApiInternal(const rtc::Rectangle &screenRect, const rtc::Rectangle &regionRect)=0
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:59
agora::rtc::IScreenCapturerEx2::startAudioCapture
virtual int startAudioCapture()=0
agora::rtc::IScreenCapturer2
Definition: NGIAgoraScreenCapturer.h:146
agora::ERR_NOT_SUPPORTED
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:477
agora::rtc::IScreenCapturerEx2::deinit
virtual void deinit()
Definition: screen_capture_i.h:106
agora::rtc::IScreenCapturerEx::GetCaptureToTexture
virtual void GetCaptureToTexture(bool &capture_to_texture)
Definition: screen_capture_i.h:64
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:98
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:37
agora::rtc::IScreenCapturerEx2::stopVideoCapture
virtual int stopVideoCapture()=0
agora::rtc::IScreenCapturerEx::SCREEN_CAPTURER_STARTED
@ SCREEN_CAPTURER_STARTED
Definition: screen_capture_i.h:25
agora::rtc::IScreenCapturerEx
Definition: screen_capture_i.h:22
agora::rtc::IScreenCapturerEx::~IScreenCapturerEx
virtual ~IScreenCapturerEx()
Definition: screen_capture_i.h:29
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1086
agora::rtc::IScreenCapturerEx::attachStatsSpace
virtual void attachStatsSpace(uint64_t stats_space)
Definition: screen_capture_i.h:84
agora::rtc::IScreenCapturerEx2::attachStatsSpace
virtual void attachStatsSpace(uint64_t stats_space)
Definition: screen_capture_i.h:107
agora::rtc::IScreenCapturerEx2::setScreenCaptureDimensionsLLApiInternal
virtual int setScreenCaptureDimensionsLLApiInternal(const VideoDimensions &dimensions)=0
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:61
rtc::VideoSinkInterface
Definition: video_node_i.h:32
agora::rtc::IScreenCapturerEx2::startVideoCapture
virtual int startVideoCapture()=0
rtc
Definition: video_node_i.h:28
agora::rtc::IScreenCapturerEx2::setAudioVolumeLLApiInternal
virtual int setAudioVolumeLLApiInternal(uint32_t volume)=0
agora::rtc::IScreenCapturerEx::StartCapture
virtual int StartCapture()=0