Agora Java API Reference for Android
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
17 namespace agora {
18 namespace rtc {
19 
21  int capture_type;
22  uint32_t captured_frame_width;
23  uint32_t captured_frame_height;
24  uint32_t total_captured_frames;
25  uint64_t per_frame_cap_time_ms;
26  uint64_t per_capture_cpu_cycles;
27  bool capture_mouse_cursor;
28  uint32_t target_fps;
29  uint32_t real_capture_fps;
30  uint32_t capture_out_fps;
31  uint32_t drop_fps;
32 
34  : capture_type(-1), captured_frame_width(0), captured_frame_height(0),
35  total_captured_frames(0), per_frame_cap_time_ms(0),
36  per_capture_cpu_cycles(0), capture_mouse_cursor(true),
37  target_fps(0), real_capture_fps(0),
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;
51  virtual agora::agora_refptr<IVideoFrameMemoryPool> getMemoryPool() = 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;
62  int sample_rate_hz;
63  int num_channels;
64  AudioCaptureConfig() : volume(0), sample_rate_hz(0), num_channels(0) {}
65  };
66 
67 #if defined (__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE) || defined(__OHOS__)
68  struct VideoCaptureConfig {
69  agora::rtc::VideoDimensions dimensions;
70  int frameRate;
72  : dimensions(640, 360), frameRate(15) {}
73  };
74 #else
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 
98  int thumb_width;
99  int thumb_height;
100  int icon_width;
101  int icon_height;
102  bool include_screen;
103  bool unfiltered;
104  bool unskip_system_window;
105  bool ignore_unresponsive;
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 
114  virtual ~IScreenCaptureSource() {}
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 
124  virtual CaptureMode getVideoCaptureMode() = 0;
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 
140  virtual int setScreenCaptureDimensions(const agora::rtc::VideoDimensions& dimensions) {
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  }
152  virtual int capture(agora::agora_refptr<IVideoFrame>& frame) {
153  return -ERR_NOT_SUPPORTED;
154  }
155  virtual int getProfilingStats(ScreenCaptureProfilingStatistics& stats) {
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::ScreenCaptureProfilingStatistics
Definition: NGIAgoraExtensionScreenSource.h:20
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::Rectangle
Definition: AgoraBase.h:2281
agora::media::IAudioFrameObserverBase::AudioFrame
Definition: AgoraMediaBase.h:1282
agora::rtc::IScreenCaptureSource::ScreenSourceListOption
Definition: NGIAgoraExtensionScreenSource.h:97
agora::rtc::IScreenCaptureSource::AudioCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:60
agora::rtc::IScreenCaptureSource::Control
Definition: NGIAgoraExtensionScreenSource.h:43
agora::rtc::IScreenCaptureSource
Definition: NGIAgoraExtensionScreenSource.h:41
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::VideoDimensions
Definition: AgoraBase.h:1139
agora::rtc::IScreenCaptureSource::VideoCaptureConfig
Definition: NGIAgoraExtensionScreenSource.h:75