Agora RTC Objective-C API Reference  Refactor
NGIAgoraExtensionScreenSource.h
Go to the documentation of this file.
1 //
2 // Agora SDK
3 //
4 // Copyright (c) 2021 Agora.io. All rights reserved.
5 //
6 
7 #pragma once // NOLINT(build/header_guard)
8 
9 #include "AgoraBase.h"
10 #include "IAgoraLog.h"
11 #include "AgoraRefPtr.h"
12 #include "NGIAgoraVideoFrame.h"
13 #include "AgoraMediaBase.h"
14 #if defined(WEBRTC_IOS)
15 #include <coreVideo/CVPixelBuffer.h>
16 #endif
17 namespace agora {
18 namespace rtc {
19 
28  uint32_t target_fps;
29  uint32_t real_capture_fps;
30  uint32_t capture_out_fps;
31  uint32_t drop_fps;
32 
38  capture_out_fps(0), drop_fps(0) {}
39 };
40 
42  public:
43  class Control : public RefCountInterface {
44  public:
45  virtual int postEvent(const char* key, const char* value) = 0;
46  virtual void printLog(commons::LOG_LEVEL level, const char* format, ...) = 0;
47  virtual void printLog(commons::LOG_LEVEL level, const char* fromat, va_list) = 0;
48  virtual int pushAudioFrame(const media::IAudioFrameObserver::AudioFrame& captured_frame) = 0;
49  virtual bool timeToPushVideo() = 0;
50  virtual int pushVideoFrame(const agora::agora_refptr<IVideoFrame>& captured_frame) = 0;
52 #if defined(WEBRTC_IOS)
53  virtual int pushVideoFrame(CVPixelBufferRef pixelBuffer, int64_t timestamp_ms, uint32_t rotation) = 0;
54 #endif
55 #if defined(WEBRTC_WIN)
56  virtual void recycleVideoCache() = 0;
57 #endif
58  };
59 
61  uint32_t volume;
65  };
66 
67 #if defined (__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
70  int frameRate;
72  : dimensions(640, 360), frameRate(15) {}
73  };
74 #else
75  struct VideoCaptureConfig {
76  enum CaptureType {
77  CaptureWindow,
78  CaptureScreen,
79  };
80  CaptureType type;
81  Rectangle screen_rect;
82  Rectangle region_offset;
83  int64_t display_id;
84  view_t window_id;
85 
86  bool window_focused;
87 
88  // Mac only
89  bool disable_avf;
90  bool disable_frame_transparent_check;
91 
93  : type(CaptureScreen), screen_rect(), region_offset(), display_id(0), window_id(NULL), window_focused(false), disable_avf(false), disable_frame_transparent_check(false) { }
94  };
95 #endif
96 
106  };
107 
108  enum CaptureMode {
109  kPull, // SDK needs to poll the captured frame actively
110  kPush // Capture source pushes the captured frame to sdk
111  };
112 
113 
115 
116  virtual int initializeCapture(const agora_refptr<Control>& control) = 0;
117 
118  virtual int initVideo(const VideoCaptureConfig& config) = 0;
119  // Start video capture interface for desktop capturing
120  virtual int startVideoCapture(const VideoCaptureConfig& config) = 0;
121  virtual int stopVideoCapture() = 0;
122  virtual int stopVideoCaptureAsync() = 0;
123 
125 
126  // Implementation of the following interfaces are not mandatory
127  virtual int startAudioCapture(const AudioCaptureConfig& config) {
128  return -ERR_NOT_SUPPORTED;
129  }
130  virtual int stopAudioCapture() {
131  return -ERR_NOT_SUPPORTED;
132  }
133  virtual int setAudioVolume(uint32_t volume) {
134  return -ERR_NOT_SUPPORTED;
135  }
136  virtual int setFrameRate(int fps) {
137  return -ERR_NOT_SUPPORTED;
138  }
139 
141  return -ERR_NOT_SUPPORTED;
142  }
143  virtual int updateCaptureRegion(const agora::rtc::Rectangle& captureRegion) {
144  return -ERR_NOT_SUPPORTED;
145  }
146  virtual int setExcludeWindowList(void* const * handles, int count) {
147  return -ERR_NOT_SUPPORTED;
148  }
149  virtual int captureMouseCursor(bool capture) {
150  return -ERR_NOT_SUPPORTED;
151  }
153  return -ERR_NOT_SUPPORTED;
154  }
156  return -ERR_NOT_SUPPORTED;
157  }
158  virtual int getScreenDimensions(int& width, int& height) {
159  return ERR_NOT_SUPPORTED;
160  }
161  virtual int setProperty(const char* key, const char* json_value) {
162  return -ERR_NOT_SUPPORTED;
163  }
164  virtual int setCustomContext(const char* key, const void* context) {
165  return -ERR_NOT_SUPPORTED;
166  }
167  virtual int getProperty(const char* key, char* json_value, int& length) {
168  return -ERR_NOT_SUPPORTED;
169  }
170  virtual int setHighLight(bool isHighLight, unsigned int color, int width) {
171  return -ERR_NOT_SUPPORTED;
172  }
173  virtual int setContentType(int contentType) {
174  return -ERR_NOT_SUPPORTED;
175  }
176  virtual void* getCustomContext(const char* key) {
177  return NULL;
178  }
179  virtual void* getScreenCaptureSources(const ScreenSourceListOption& option) {
180  return NULL;
181  }
182  virtual void setFrameCopy(bool frameCopy) {};
183 #if defined(WEBRTC_ANDROID) && !defined(RTC_EXCLUDE_JAVA)
184  virtual void setSmoothCapture(bool smoothCapture) {};
185  virtual void setResetVitualDisplay(bool reset) {};
186 #endif
187 #if defined(WEBRTC_ANDROID)
188  virtual int setExternalMediaProjection(void* mediaProjection) {
189  return -ERR_NOT_SUPPORTED;
190  }
191 #endif
192 };
193 
194 } // namespace rtc
195 } // namespace agora
agora::rtc::IScreenCaptureSource::updateCaptureRegion
virtual int updateCaptureRegion(const agora::rtc::Rectangle &captureRegion)
Definition: NGIAgoraExtensionScreenSource.h:143
agora::rtc::IScreenCaptureSource::getProfilingStats
virtual int getProfilingStats(ScreenCaptureProfilingStatistics &stats)
Definition: NGIAgoraExtensionScreenSource.h:155
agora::rtc::ScreenCaptureProfilingStatistics
Definition: NGIAgoraExtensionScreenSource.h:20
agora::rtc::IScreenCaptureSource::startVideoCapture
virtual int startVideoCapture(const VideoCaptureConfig &config)=0
agora::rtc::ScreenCaptureProfilingStatistics::captured_frame_height
uint32_t captured_frame_height
Definition: NGIAgoraExtensionScreenSource.h:23
AgoraBase.h
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::IScreenCaptureSource::stopVideoCapture
virtual int stopVideoCapture()=0
agora::rtc::ScreenCaptureProfilingStatistics::per_frame_cap_time_ms
uint64_t per_frame_cap_time_ms
Definition: NGIAgoraExtensionScreenSource.h:25
agora::rtc::IScreenCaptureSource::setHighLight
virtual int setHighLight(bool isHighLight, unsigned int color, int width)
Definition: NGIAgoraExtensionScreenSource.h:170
agora::rtc::IScreenCaptureSource::kPull
@ kPull
Definition: NGIAgoraExtensionScreenSource.h:109
agora::rtc::IScreenCaptureSource::Control::postEvent
virtual int postEvent(const char *key, const char *value)=0
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::ignore_unresponsive
bool ignore_unresponsive
Definition: NGIAgoraExtensionScreenSource.h:105
agora::rtc::ScreenCaptureProfilingStatistics::captured_frame_width
uint32_t captured_frame_width
Definition: NGIAgoraExtensionScreenSource.h:22
agora::rtc::Rectangle
Definition: AgoraBase.h:2281
agora::media::IAudioFrameObserverBase::AudioFrame
Definition: AgoraMediaBase.h:1282
agora::view_t
void * view_t
Definition: AgoraBase.h:854
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::include_screen
bool include_screen
Definition: NGIAgoraExtensionScreenSource.h:102
agora::rtc::IScreenCaptureSource::VideoCaptureConfig::dimensions
agora::rtc::VideoDimensions dimensions
Definition: NGIAgoraExtensionScreenSource.h:69
agora::rtc::IScreenCaptureSource::getVideoCaptureMode
virtual CaptureMode getVideoCaptureMode()=0
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::AudioCaptureConfig
AudioCaptureConfig()
Definition: NGIAgoraExtensionScreenSource.h:64
agora::rtc::IScreenCaptureSource::Control::printLog
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::IScreenCaptureSource::ScreenSourceListOption
Definition: NGIAgoraExtensionScreenSource.h:97
agora::rtc::ScreenCaptureProfilingStatistics::ScreenCaptureProfilingStatistics
ScreenCaptureProfilingStatistics()
Definition: NGIAgoraExtensionScreenSource.h:33
agora::rtc::IScreenCaptureSource::AudioCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:60
agora::rtc::IScreenCaptureSource::setCustomContext
virtual int setCustomContext(const char *key, const void *context)
Definition: NGIAgoraExtensionScreenSource.h:164
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::volume
uint32_t volume
Definition: NGIAgoraExtensionScreenSource.h:61
agora::rtc::ScreenCaptureProfilingStatistics::drop_fps
uint32_t drop_fps
Definition: NGIAgoraExtensionScreenSource.h:31
NGIAgoraVideoFrame.h
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::num_channels
int num_channels
Definition: NGIAgoraExtensionScreenSource.h:63
agora::commons::LOG_LEVEL
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:33
agora::rtc::ScreenCaptureProfilingStatistics::real_capture_fps
uint32_t real_capture_fps
Definition: NGIAgoraExtensionScreenSource.h:29
agora::rtc::IScreenCaptureSource::Control::getMemoryPool
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::thumb_width
int thumb_width
Definition: NGIAgoraExtensionScreenSource.h:98
agora::rtc::IScreenCaptureSource::initializeCapture
virtual int initializeCapture(const agora_refptr< Control > &control)=0
agora::rtc::IScreenCaptureSource::setContentType
virtual int setContentType(int contentType)
Definition: NGIAgoraExtensionScreenSource.h:173
agora::rtc::IScreenCaptureSource::capture
virtual int capture(agora::agora_refptr< IVideoFrame > &frame)
Definition: NGIAgoraExtensionScreenSource.h:152
agora::rtc::ScreenCaptureProfilingStatistics::capture_out_fps
uint32_t capture_out_fps
Definition: NGIAgoraExtensionScreenSource.h:30
agora::rtc::IScreenCaptureSource::setAudioVolume
virtual int setAudioVolume(uint32_t volume)
Definition: NGIAgoraExtensionScreenSource.h:133
agora::rtc::IScreenCaptureSource::setProperty
virtual int setProperty(const char *key, const char *json_value)
Definition: NGIAgoraExtensionScreenSource.h:161
agora::rtc::IScreenCaptureSource::Control
Definition: NGIAgoraExtensionScreenSource.h:43
agora::rtc::IScreenCaptureSource::VideoCaptureConfig::VideoCaptureConfig
VideoCaptureConfig()
Definition: NGIAgoraExtensionScreenSource.h:71
agora::rtc::IScreenCaptureSource::kPush
@ kPush
Definition: NGIAgoraExtensionScreenSource.h:110
agora::rtc::ScreenCaptureProfilingStatistics::target_fps
uint32_t target_fps
Definition: NGIAgoraExtensionScreenSource.h:28
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::thumb_height
int thumb_height
Definition: NGIAgoraExtensionScreenSource.h:99
agora::rtc::IScreenCaptureSource::setFrameCopy
virtual void setFrameCopy(bool frameCopy)
Definition: NGIAgoraExtensionScreenSource.h:182
IAgoraLog.h
agora::rtc::IScreenCaptureSource::setScreenCaptureDimensions
virtual int setScreenCaptureDimensions(const agora::rtc::VideoDimensions &dimensions)
Definition: NGIAgoraExtensionScreenSource.h:140
agora::rtc::IScreenCaptureSource::getScreenDimensions
virtual int getScreenDimensions(int &width, int &height)
Definition: NGIAgoraExtensionScreenSource.h:158
agora::rtc::IScreenCaptureSource::getScreenCaptureSources
virtual void * getScreenCaptureSources(const ScreenSourceListOption &option)
Definition: NGIAgoraExtensionScreenSource.h:179
agora::rtc::IScreenCaptureSource::Control::pushVideoFrame
virtual int pushVideoFrame(const agora::agora_refptr< IVideoFrame > &captured_frame)=0
AgoraRefPtr.h
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::sample_rate_hz
int sample_rate_hz
Definition: NGIAgoraExtensionScreenSource.h:62
agora::rtc::IScreenCaptureSource::getCustomContext
virtual void * getCustomContext(const char *key)
Definition: NGIAgoraExtensionScreenSource.h:176
AgoraMediaBase.h
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::unskip_system_window
bool unskip_system_window
Definition: NGIAgoraExtensionScreenSource.h:104
agora::rtc::IScreenCaptureSource
Definition: NGIAgoraExtensionScreenSource.h:41
agora::rtc::IScreenCaptureSource::VideoCaptureConfig::frameRate
int frameRate
Definition: NGIAgoraExtensionScreenSource.h:70
agora::rtc::IScreenCaptureSource::stopAudioCapture
virtual int stopAudioCapture()
Definition: NGIAgoraExtensionScreenSource.h:130
agora::rtc::ScreenCaptureProfilingStatistics::total_captured_frames
uint32_t total_captured_frames
Definition: NGIAgoraExtensionScreenSource.h:24
agora::rtc::ScreenCaptureProfilingStatistics::per_capture_cpu_cycles
uint64_t per_capture_cpu_cycles
Definition: NGIAgoraExtensionScreenSource.h:26
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IScreenCaptureSource::getProperty
virtual int getProperty(const char *key, char *json_value, int &length)
Definition: NGIAgoraExtensionScreenSource.h:167
agora::rtc::IScreenCaptureSource::setFrameRate
virtual int setFrameRate(int fps)
Definition: NGIAgoraExtensionScreenSource.h:136
agora::rtc::IScreenCaptureSource::CaptureMode
CaptureMode
Definition: NGIAgoraExtensionScreenSource.h:108
agora::rtc::IScreenCaptureSource::startAudioCapture
virtual int startAudioCapture(const AudioCaptureConfig &config)
Definition: NGIAgoraExtensionScreenSource.h:127
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1139
agora::rtc::ScreenCaptureProfilingStatistics::capture_type
int capture_type
Definition: NGIAgoraExtensionScreenSource.h:21
agora::rtc::ScreenCaptureProfilingStatistics::capture_mouse_cursor
bool capture_mouse_cursor
Definition: NGIAgoraExtensionScreenSource.h:27
agora::rtc::IScreenCaptureSource::Control::timeToPushVideo
virtual bool timeToPushVideo()=0
agora::rtc::IScreenCaptureSource::~IScreenCaptureSource
virtual ~IScreenCaptureSource()
Definition: NGIAgoraExtensionScreenSource.h:114
agora::rtc::IScreenCaptureSource::Control::pushAudioFrame
virtual int pushAudioFrame(const media::IAudioFrameObserver::AudioFrame &captured_frame)=0
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::unfiltered
bool unfiltered
Definition: NGIAgoraExtensionScreenSource.h:103
agora::rtc::IScreenCaptureSource::Control::printLog
virtual void printLog(commons::LOG_LEVEL level, const char *fromat, va_list)=0
agora::rtc::IScreenCaptureSource::stopVideoCaptureAsync
virtual int stopVideoCaptureAsync()=0
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::icon_height
int icon_height
Definition: NGIAgoraExtensionScreenSource.h:101
agora::ERR_NOT_SUPPORTED
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:481
agora::rtc::IScreenCaptureSource::initVideo
virtual int initVideo(const VideoCaptureConfig &config)=0
agora::rtc::IScreenCaptureSource::VideoCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:68
agora::rtc::IScreenCaptureSource::ScreenSourceListOption::icon_width
int icon_width
Definition: NGIAgoraExtensionScreenSource.h:100
agora::rtc::IScreenCaptureSource::setExcludeWindowList
virtual int setExcludeWindowList(void *const *handles, int count)
Definition: NGIAgoraExtensionScreenSource.h:146
agora::rtc::IScreenCaptureSource::captureMouseCursor
virtual int captureMouseCursor(bool capture)
Definition: NGIAgoraExtensionScreenSource.h:149