Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
NGIAgoraExtensionScreenSource.h
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
17namespace agora {
18namespace rtc {
19
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
66
67#if defined (__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
74#else
75 struct VideoCaptureConfig {
76 #if !defined(__linux__)
77 enum class CapturerMode {
79 // Mac only
83 };
84 #endif
85
93 int64_t display_id;
95
97
98 // Mac only
101#if !defined(__linux__)
103
104 bool captureAudio = false;
106 int audio_sample_rate = 48000;
108#endif
109
112 };
113#endif
114
124
125#if defined(WEBRTC_MAC) && !defined(WEBRTC_IOS)
126 enum class ApiType {
130 };
132#endif
133 };
134
136 kPull, // SDK needs to poll the captured frame actively
137 kPush // Capture source pushes the captured frame to sdk
138 };
139
140
142
143 virtual int initializeCapture(const agora_refptr<Control>& control) = 0;
144
145 virtual int initVideo(const VideoCaptureConfig& config) = 0;
146 // Start video capture interface for desktop capturing
147 virtual int startVideoCapture(const VideoCaptureConfig& config) = 0;
148 virtual int stopVideoCapture() = 0;
149 virtual int stopVideoCaptureAsync() = 0;
150
152
153 // Implementation of the following interfaces are not mandatory
154 virtual bool isAudioCaptureSupported() {
155 return false;
156 }
157 virtual int startAudioCapture(const AudioCaptureConfig& config) {
158 return -ERR_NOT_SUPPORTED;
159 }
160 virtual int stopAudioCapture() {
161 return -ERR_NOT_SUPPORTED;
162 }
163 virtual int setAudioVolume(uint32_t volume) {
164 return -ERR_NOT_SUPPORTED;
165 }
166 virtual int setFrameRate(int fps) {
167 return -ERR_NOT_SUPPORTED;
168 }
169
171 return -ERR_NOT_SUPPORTED;
172 }
173 virtual int updateCaptureRegion(const agora::rtc::Rectangle& captureRegion) {
174 return -ERR_NOT_SUPPORTED;
175 }
176 virtual int setExcludeWindowList(void* const * handles, int count) {
177 return -ERR_NOT_SUPPORTED;
178 }
179 virtual int captureMouseCursor(bool capture) {
180 return -ERR_NOT_SUPPORTED;
181 }
183 return -ERR_NOT_SUPPORTED;
184 }
188 virtual int getScreenDimensions(int& width, int& height) {
189 return ERR_NOT_SUPPORTED;
190 }
191 virtual int setProperty(const char* key, const char* json_value) {
192 return -ERR_NOT_SUPPORTED;
193 }
194 virtual int setCustomContext(const char* key, const void* context) {
195 return -ERR_NOT_SUPPORTED;
196 }
197 virtual int getProperty(const char* key, char* json_value, int& length) {
198 return -ERR_NOT_SUPPORTED;
199 }
200 virtual int setHighLight(bool isHighLight, unsigned int color, int width) {
201 return -ERR_NOT_SUPPORTED;
202 }
203 virtual int setContentType(int contentType) {
204 return -ERR_NOT_SUPPORTED;
205 }
206 virtual void* getCustomContext(const char* key) {
207 return NULL;
208 }
209 virtual void* getScreenCaptureSources(const ScreenSourceListOption& option) {
210 return NULL;
211 }
212 virtual void setFrameCopy(bool frameCopy) {};
213#if defined(WEBRTC_ANDROID) && !defined(RTC_EXCLUDE_JAVA)
214 virtual void setSmoothCapture(bool smoothCapture) {};
215 virtual void setResetVitualDisplay(bool reset) {};
216#endif
217#if defined(WEBRTC_ANDROID)
218 virtual int setExternalMediaProjection(void* mediaProjection) {
219 return -ERR_NOT_SUPPORTED;
220 }
221#endif
222};
223
224} // namespace rtc
225} // namespace agora
Definition AgoraRefPtr.h:31
Definition AgoraRefPtr.h:44
Definition NGIAgoraExtensionScreenSource.h:43
virtual int pushVideoFrame(CVPixelBufferRef pixelBuffer, int64_t timestamp_ms, uint32_t rotation)=0
virtual agora::agora_refptr< IVideoFrameMemoryPool > getMemoryPool()=0
virtual void printLog(commons::LOG_LEVEL level, const char *fromat, va_list)=0
virtual int postEvent(const char *key, const char *value)=0
virtual void printLog(commons::LOG_LEVEL level, const char *format,...)=0
virtual int pushAudioFrame(const media::IAudioFrameObserver::AudioFrame &captured_frame)=0
virtual int pushVideoFrame(const agora::agora_refptr< IVideoFrame > &captured_frame)=0
Definition NGIAgoraExtensionScreenSource.h:41
virtual int setExternalMediaProjection(void *mediaProjection)
Definition NGIAgoraExtensionScreenSource.h:218
virtual ~IScreenCaptureSource()
Definition NGIAgoraExtensionScreenSource.h:141
virtual int setProperty(const char *key, const char *json_value)
Definition NGIAgoraExtensionScreenSource.h:191
virtual void setResetVitualDisplay(bool reset)
Definition NGIAgoraExtensionScreenSource.h:215
virtual int stopVideoCaptureAsync()=0
virtual int initVideo(const VideoCaptureConfig &config)=0
virtual int startAudioCapture(const AudioCaptureConfig &config)
Definition NGIAgoraExtensionScreenSource.h:157
virtual int getProperty(const char *key, char *json_value, int &length)
Definition NGIAgoraExtensionScreenSource.h:197
virtual int updateCaptureRegion(const agora::rtc::Rectangle &captureRegion)
Definition NGIAgoraExtensionScreenSource.h:173
virtual int capture(agora::agora_refptr< IVideoFrame > &frame)
Definition NGIAgoraExtensionScreenSource.h:182
CaptureMode
Definition NGIAgoraExtensionScreenSource.h:135
@ kPush
Definition NGIAgoraExtensionScreenSource.h:137
@ kPull
Definition NGIAgoraExtensionScreenSource.h:136
virtual int getScreenDimensions(int &width, int &height)
Definition NGIAgoraExtensionScreenSource.h:188
virtual CaptureMode getVideoCaptureMode()=0
virtual int captureMouseCursor(bool capture)
Definition NGIAgoraExtensionScreenSource.h:179
virtual int setAudioVolume(uint32_t volume)
Definition NGIAgoraExtensionScreenSource.h:163
virtual int stopAudioCapture()
Definition NGIAgoraExtensionScreenSource.h:160
virtual bool isAudioCaptureSupported()
Definition NGIAgoraExtensionScreenSource.h:154
virtual void setFrameCopy(bool frameCopy)
Definition NGIAgoraExtensionScreenSource.h:212
virtual void setSmoothCapture(bool smoothCapture)
Definition NGIAgoraExtensionScreenSource.h:214
virtual int setContentType(int contentType)
Definition NGIAgoraExtensionScreenSource.h:203
virtual int getProfilingStats(ScreenCaptureProfilingStatistics &stats)
Definition NGIAgoraExtensionScreenSource.h:185
virtual int setHighLight(bool isHighLight, unsigned int color, int width)
Definition NGIAgoraExtensionScreenSource.h:200
virtual int startVideoCapture(const VideoCaptureConfig &config)=0
virtual int setCustomContext(const char *key, const void *context)
Definition NGIAgoraExtensionScreenSource.h:194
virtual int setScreenCaptureDimensions(const agora::rtc::VideoDimensions &dimensions)
Definition NGIAgoraExtensionScreenSource.h:170
virtual int setFrameRate(int fps)
Definition NGIAgoraExtensionScreenSource.h:166
virtual void * getScreenCaptureSources(const ScreenSourceListOption &option)
Definition NGIAgoraExtensionScreenSource.h:209
virtual int initializeCapture(const agora_refptr< Control > &control)=0
virtual void * getCustomContext(const char *key)
Definition NGIAgoraExtensionScreenSource.h:206
virtual int setExcludeWindowList(void *const *handles, int count)
Definition NGIAgoraExtensionScreenSource.h:176
OPTIONAL_ENUM_CLASS LOG_LEVEL
The output log level of the SDK.
Definition IAgoraLog.h:33
Definition AgoraExtensions.h:5
Definition AgoraAtomicOps.h:21
void * view_t
Definition AgoraBase.h:935
@ ERR_NOT_SUPPORTED
Definition AgoraBase.h:507
Raw audio data.
Definition AgoraMediaBase.h:1436
Definition NGIAgoraExtensionScreenSource.h:60
int num_channels
Definition NGIAgoraExtensionScreenSource.h:63
AudioCaptureConfig()
Definition NGIAgoraExtensionScreenSource.h:64
int sample_rate_hz
Definition NGIAgoraExtensionScreenSource.h:62
uint32_t volume
Definition NGIAgoraExtensionScreenSource.h:61
Definition NGIAgoraExtensionScreenSource.h:115
bool ignore_unresponsive
Definition NGIAgoraExtensionScreenSource.h:123
int icon_width
Definition NGIAgoraExtensionScreenSource.h:118
int icon_height
Definition NGIAgoraExtensionScreenSource.h:119
ApiType api_type
Definition NGIAgoraExtensionScreenSource.h:131
bool unskip_system_window
Definition NGIAgoraExtensionScreenSource.h:122
bool unfiltered
Definition NGIAgoraExtensionScreenSource.h:121
bool include_screen
Definition NGIAgoraExtensionScreenSource.h:120
ApiType
Definition NGIAgoraExtensionScreenSource.h:126
@ kCGDisplay
Definition NGIAgoraExtensionScreenSource.h:128
@ kUnspecified
Definition NGIAgoraExtensionScreenSource.h:127
@ kNSScreen
Definition NGIAgoraExtensionScreenSource.h:129
int thumb_height
Definition NGIAgoraExtensionScreenSource.h:117
int thumb_width
Definition NGIAgoraExtensionScreenSource.h:116
Definition NGIAgoraExtensionScreenSource.h:68
int frameRate
Definition NGIAgoraExtensionScreenSource.h:70
bool disable_avf
Definition NGIAgoraExtensionScreenSource.h:99
CapturerMode
Definition NGIAgoraExtensionScreenSource.h:77
@ kScreenCaptureKit
Definition NGIAgoraExtensionScreenSource.h:80
@ kUnspecified
Definition NGIAgoraExtensionScreenSource.h:78
@ kAVFoundation
Definition NGIAgoraExtensionScreenSource.h:82
@ kCoreGraphic
Definition NGIAgoraExtensionScreenSource.h:81
Rectangle region_offset
Definition NGIAgoraExtensionScreenSource.h:92
int64_t display_id
Definition NGIAgoraExtensionScreenSource.h:93
view_t window_id
Definition NGIAgoraExtensionScreenSource.h:94
bool captureAudio
Definition NGIAgoraExtensionScreenSource.h:104
VideoCaptureConfig()
Definition NGIAgoraExtensionScreenSource.h:71
int audio_sample_rate
Definition NGIAgoraExtensionScreenSource.h:106
CaptureType
Definition NGIAgoraExtensionScreenSource.h:86
@ CaptureScreen
Definition NGIAgoraExtensionScreenSource.h:88
@ CaptureWindow
Definition NGIAgoraExtensionScreenSource.h:87
bool window_focused
Definition NGIAgoraExtensionScreenSource.h:96
int audio_channel_count
Definition NGIAgoraExtensionScreenSource.h:105
bool disable_frame_transparent_check
Definition NGIAgoraExtensionScreenSource.h:100
CapturerMode capturerMode
Definition NGIAgoraExtensionScreenSource.h:102
bool excludeCurrentProcessAudio
Definition NGIAgoraExtensionScreenSource.h:107
Rectangle screen_rect
Definition NGIAgoraExtensionScreenSource.h:91
CaptureType type
Definition NGIAgoraExtensionScreenSource.h:90
agora::rtc::VideoDimensions dimensions
Definition NGIAgoraExtensionScreenSource.h:69
The location of the target area relative to the screen or window. If you do not set this parameter,...
Definition AgoraBase.h:2429
Definition NGIAgoraExtensionScreenSource.h:20
uint32_t real_capture_fps
Definition NGIAgoraExtensionScreenSource.h:29
int capture_type
Definition NGIAgoraExtensionScreenSource.h:21
uint64_t per_frame_cap_time_ms
Definition NGIAgoraExtensionScreenSource.h:25
uint32_t captured_frame_width
Definition NGIAgoraExtensionScreenSource.h:22
bool capture_mouse_cursor
Definition NGIAgoraExtensionScreenSource.h:27
uint32_t target_fps
Definition NGIAgoraExtensionScreenSource.h:28
ScreenCaptureProfilingStatistics()
Definition NGIAgoraExtensionScreenSource.h:33
uint32_t captured_frame_height
Definition NGIAgoraExtensionScreenSource.h:23
uint32_t capture_out_fps
Definition NGIAgoraExtensionScreenSource.h:30
uint32_t drop_fps
Definition NGIAgoraExtensionScreenSource.h:31
uint32_t total_captured_frames
Definition NGIAgoraExtensionScreenSource.h:24
uint64_t per_capture_cpu_cycles
Definition NGIAgoraExtensionScreenSource.h:26
The video dimension.
Definition AgoraBase.h:1252