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 
15 namespace agora {
16 namespace rtc {
17 
26 
31 };
32 
34  public:
35  class Control : public RefCountInterface {
36  public:
37  virtual int postEvent(const char* key, const char* value) = 0;
38  virtual void printLog(commons::LOG_LEVEL level, const char* format, ...) = 0;
39  virtual int pushAudioFrame(const media::IAudioFrameObserver::AudioFrame& captured_frame) = 0;
40  virtual bool timeToPushVideo() = 0;
41  virtual int pushVideoFrame(const agora::agora_refptr<IVideoFrame>& captured_frame) = 0;
43  };
44 
46  uint32_t volume;
50  };
51 
52 #if defined (__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
56  : dimensions(640, 360) {}
57  };
58 #else
59  struct VideoCaptureConfig {
60  enum CaptureType {
61  CaptureWindow,
62  CaptureScreen,
63  };
64  CaptureType type;
65  Rectangle screen_rect;
66  Rectangle region_offset;
67  uint32_t display_id;
68  view_t window_id;
69 
71  : type(CaptureScreen), screen_rect(), region_offset(), display_id(0), window_id(NULL) { }
72  };
73 #endif
74  enum CaptureMode {
75  kPull, // SDK needs to poll the captured frame actively
76  kPush // Capture source pushes the captured frame to sdk
77  };
78 
79  virtual ~IScreenCaptureSource() {}
80 
81  virtual int initializeCapture(const agora_refptr<Control>& control) = 0;
82 
83  // Start video capture interface for desktop capturing
84  virtual int startVideoCapture(const VideoCaptureConfig& config) = 0;
85  virtual int stopVideoCapture() = 0;
86 
88 
89  // Implementation of the following interfaces are not mandatory
90  virtual int startAudioCapture(const AudioCaptureConfig& config) {
91  return -ERR_NOT_SUPPORTED;
92  }
93  virtual int stopAudioCapture() {
94  return -ERR_NOT_SUPPORTED;
95  }
96  virtual int setAudioVolume(uint32_t volume) {
97  return -ERR_NOT_SUPPORTED;
98  }
99  virtual int setFrameRate(int fps) {
100  return -ERR_NOT_SUPPORTED;
101  }
103  return -ERR_NOT_SUPPORTED;
104  }
105  virtual int updateCaptureRegion(const agora::rtc::Rectangle& captureRegion) {
106  return -ERR_NOT_SUPPORTED;
107  }
108  virtual int setExcludeWindowList(void* const * handles, int count) {
109  return -ERR_NOT_SUPPORTED;
110  }
111  virtual int captureMouseCursor(bool capture) {
112  return -ERR_NOT_SUPPORTED;
113  }
115  return -ERR_NOT_SUPPORTED;
116  }
118  return -ERR_NOT_SUPPORTED;
119  }
120  virtual int getScreenDimensions(int& width, int& height) {
121  return ERR_NOT_SUPPORTED;
122  }
123  virtual int setProperty(const char* key, const char* json_value) {
124  return -ERR_NOT_SUPPORTED;
125  }
126  virtual int setCustomContext(const char* key, const void* context) {
127  return -ERR_NOT_SUPPORTED;
128  }
129  virtual int getProperty(const char* key, char* json_value, int& length) {
130  return -ERR_NOT_SUPPORTED;
131  }
132  virtual void* getCustomContext(const char* key) {
133  return NULL;
134  }
135  virtual void* getScreenCaptureSources(int thumb_cx, int thumb_cy, int icon_cx, int icon_cy,
136  bool include_screen) {
137  return NULL;
138  }
139 };
140 
141 } // namespace rtc
142 } // namespace agora
agora::rtc::IScreenCaptureSource::updateCaptureRegion
virtual int updateCaptureRegion(const agora::rtc::Rectangle &captureRegion)
Definition: NGIAgoraExtensionScreenSource.h:105
agora::rtc::IScreenCaptureSource::getProfilingStats
virtual int getProfilingStats(ScreenCaptureProfilingStatistics &stats)
Definition: NGIAgoraExtensionScreenSource.h:117
agora::rtc::ScreenCaptureProfilingStatistics
Definition: NGIAgoraExtensionScreenSource.h:18
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:21
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:23
agora::rtc::IScreenCaptureSource::kPull
@ kPull
Definition: NGIAgoraExtensionScreenSource.h:75
agora::rtc::IScreenCaptureSource::Control::postEvent
virtual int postEvent(const char *key, const char *value)=0
agora::rtc::ScreenCaptureProfilingStatistics::captured_frame_width
uint32_t captured_frame_width
Definition: NGIAgoraExtensionScreenSource.h:20
agora::rtc::IScreenCaptureSource::getScreenCaptureSources
virtual void * getScreenCaptureSources(int thumb_cx, int thumb_cy, int icon_cx, int icon_cy, bool include_screen)
Definition: NGIAgoraExtensionScreenSource.h:135
agora::rtc::Rectangle
Definition: AgoraBase.h:1802
agora::media::IAudioFrameObserverBase::AudioFrame
Definition: AgoraMediaBase.h:804
agora::view_t
void * view_t
Definition: AgoraBase.h:784
agora::rtc::IScreenCaptureSource::VideoCaptureConfig::dimensions
agora::rtc::VideoDimensions dimensions
Definition: NGIAgoraExtensionScreenSource.h:54
agora::rtc::IScreenCaptureSource::getVideoCaptureMode
virtual CaptureMode getVideoCaptureMode()=0
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::AudioCaptureConfig
AudioCaptureConfig()
Definition: NGIAgoraExtensionScreenSource.h:49
agora::rtc::IScreenCaptureSource::Control::printLog
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::ScreenCaptureProfilingStatistics::ScreenCaptureProfilingStatistics
ScreenCaptureProfilingStatistics()
Definition: NGIAgoraExtensionScreenSource.h:27
agora::rtc::IScreenCaptureSource::AudioCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:45
agora::rtc::IScreenCaptureSource::setCustomContext
virtual int setCustomContext(const char *key, const void *context)
Definition: NGIAgoraExtensionScreenSource.h:126
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::volume
uint32_t volume
Definition: NGIAgoraExtensionScreenSource.h:46
NGIAgoraVideoFrame.h
agora::rtc::IScreenCaptureSource::AudioCaptureConfig::num_channels
int num_channels
Definition: NGIAgoraExtensionScreenSource.h:48
agora::commons::LOG_LEVEL
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:35
agora::rtc::IScreenCaptureSource::Control::getMemoryPool
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
agora::rtc::IScreenCaptureSource::initializeCapture
virtual int initializeCapture(const agora_refptr< Control > &control)=0
agora::rtc::IScreenCaptureSource::capture
virtual int capture(agora::agora_refptr< IVideoFrame > &frame)
Definition: NGIAgoraExtensionScreenSource.h:114
agora::rtc::IScreenCaptureSource::setAudioVolume
virtual int setAudioVolume(uint32_t volume)
Definition: NGIAgoraExtensionScreenSource.h:96
agora::rtc::IScreenCaptureSource::setProperty
virtual int setProperty(const char *key, const char *json_value)
Definition: NGIAgoraExtensionScreenSource.h:123
agora::rtc::IScreenCaptureSource::Control
Definition: NGIAgoraExtensionScreenSource.h:35
agora::rtc::IScreenCaptureSource::VideoCaptureConfig::VideoCaptureConfig
VideoCaptureConfig()
Definition: NGIAgoraExtensionScreenSource.h:55
agora::rtc::IScreenCaptureSource::kPush
@ kPush
Definition: NGIAgoraExtensionScreenSource.h:76
IAgoraLog.h
agora::rtc::IScreenCaptureSource::setScreenCaptureDimensions
virtual int setScreenCaptureDimensions(const agora::rtc::VideoDimensions &dimensions)
Definition: NGIAgoraExtensionScreenSource.h:102
agora::rtc::IScreenCaptureSource::getScreenDimensions
virtual int getScreenDimensions(int &width, int &height)
Definition: NGIAgoraExtensionScreenSource.h:120
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:47
agora::rtc::IScreenCaptureSource::getCustomContext
virtual void * getCustomContext(const char *key)
Definition: NGIAgoraExtensionScreenSource.h:132
AgoraMediaBase.h
agora::rtc::IScreenCaptureSource
Definition: NGIAgoraExtensionScreenSource.h:33
agora::rtc::IScreenCaptureSource::stopAudioCapture
virtual int stopAudioCapture()
Definition: NGIAgoraExtensionScreenSource.h:93
agora::rtc::ScreenCaptureProfilingStatistics::total_captured_frames
uint32_t total_captured_frames
Definition: NGIAgoraExtensionScreenSource.h:22
agora::rtc::ScreenCaptureProfilingStatistics::per_capture_cpu_cycles
uint64_t per_capture_cpu_cycles
Definition: NGIAgoraExtensionScreenSource.h:24
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IScreenCaptureSource::getProperty
virtual int getProperty(const char *key, char *json_value, int &length)
Definition: NGIAgoraExtensionScreenSource.h:129
agora::rtc::IScreenCaptureSource::setFrameRate
virtual int setFrameRate(int fps)
Definition: NGIAgoraExtensionScreenSource.h:99
agora::rtc::IScreenCaptureSource::CaptureMode
CaptureMode
Definition: NGIAgoraExtensionScreenSource.h:74
agora::rtc::IScreenCaptureSource::startAudioCapture
virtual int startAudioCapture(const AudioCaptureConfig &config)
Definition: NGIAgoraExtensionScreenSource.h:90
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1054
agora::rtc::ScreenCaptureProfilingStatistics::capture_type
int capture_type
Definition: NGIAgoraExtensionScreenSource.h:19
agora::rtc::ScreenCaptureProfilingStatistics::capture_mouse_cursor
bool capture_mouse_cursor
Definition: NGIAgoraExtensionScreenSource.h:25
agora::rtc::IScreenCaptureSource::Control::timeToPushVideo
virtual bool timeToPushVideo()=0
agora::rtc::IScreenCaptureSource::~IScreenCaptureSource
virtual ~IScreenCaptureSource()
Definition: NGIAgoraExtensionScreenSource.h:79
agora::rtc::IScreenCaptureSource::Control::pushAudioFrame
virtual int pushAudioFrame(const media::IAudioFrameObserver::AudioFrame &captured_frame)=0
agora::ERR_NOT_SUPPORTED
@ ERR_NOT_SUPPORTED
Definition: AgoraBase.h:485
agora::rtc::IScreenCaptureSource::VideoCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:53
agora::rtc::IScreenCaptureSource::setExcludeWindowList
virtual int setExcludeWindowList(void *const *handles, int count)
Definition: NGIAgoraExtensionScreenSource.h:108
agora::rtc::IScreenCaptureSource::captureMouseCursor
virtual int captureMouseCursor(bool capture)
Definition: NGIAgoraExtensionScreenSource.h:111