Agora RTC Objective-C API Reference Refactor

Data Structures
IScreenCaptureSource Class Referenceabstract

Inherits RefCountInterface.

## Data Structures
struct | AudioCaptureConfig
class | Control
struct | ScreenSourceListOption
struct | VideoCaptureConfig

## Member Enumeration Documentation

## ◆ CaptureMode

enum CaptureMode

Enumerator
kPull |
kPush |

## Constructor & Destructor Documentation

## ◆ ~IScreenCaptureSource()

virtual ~IScreenCaptureSource | ( |  | ) |
| inlinevirtual

## Member Function Documentation

## ◆ initializeCapture()

virtual int initializeCapture | ( | const agora_refptr< Control > & | control | ) |
| pure virtual

## ◆ initVideo()

virtual int initVideo | ( | const VideoCaptureConfig & | config | ) |
| pure virtual

## ◆ startVideoCapture()

virtual int startVideoCapture | ( | const VideoCaptureConfig & | config | ) |
| pure virtual

## ◆ stopVideoCapture()

virtual int stopVideoCapture | ( |  | ) |
| pure virtual

## ◆ getVideoCaptureMode()

virtual CaptureMode getVideoCaptureMode | ( |  | ) |
| pure virtual

## ◆ startAudioCapture()

virtual int startAudioCapture | ( | const AudioCaptureConfig & | config | ) |
| inlinevirtual

## ◆ stopAudioCapture()

virtual int stopAudioCapture | ( |  | ) |
| inlinevirtual

## ◆ setAudioVolume()

virtual int setAudioVolume | ( | uint32_t | volume | ) |
| inlinevirtual

## ◆ setFrameRate()

virtual int setFrameRate | ( | int | fps | ) |
| inlinevirtual

## ◆ setScreenCaptureDimensions()

virtual int setScreenCaptureDimensions | ( | const agora::rtc::VideoDimensions & | dimensions | ) |
| inlinevirtual

## ◆ updateCaptureRegion()

virtual int updateCaptureRegion | ( | const agora::rtc::Rectangle & | captureRegion | ) |
| inlinevirtual

## ◆ setExcludeWindowList()

virtual int setExcludeWindowList | ( | void *const * | handles,
|  | int | count
| ) |  |
| inlinevirtual

## ◆ captureMouseCursor()

virtual int captureMouseCursor | ( | bool | capture | ) |
| inlinevirtual

## ◆ capture()

virtual int capture | ( | agora::agora_refptr< IVideoFrame > & | frame | ) |
| inlinevirtual

## ◆ getProfilingStats()

virtual int getProfilingStats | ( | ScreenCaptureProfilingStatistics & | stats | ) |
| inlinevirtual

## ◆ getScreenDimensions()

virtual int getScreenDimensions | ( | int & | width,
|  | int & | height
| ) |  |
| inlinevirtual

## ◆ setProperty()

virtual int setProperty | ( | const char * | key,
|  | const char * | json_value
| ) |  |
| inlinevirtual

## ◆ setCustomContext()

virtual int setCustomContext | ( | const char * | key,
|  | const void * | context
| ) |  |
| inlinevirtual

## ◆ getProperty()

virtual int getProperty | ( | const char * | key,
|  | char * | json_value,
|  | int & | length
| ) |  |
| inlinevirtual

## ◆ setHighLight()

virtual int setHighLight | ( | bool | isHighLight,
|  | unsigned int | color,
|  | int | width
| ) |  |
| inlinevirtual

## ◆ setContentType()

virtual int setContentType | ( | int | contentType | ) |
| inlinevirtual

## ◆ getCustomContext()

virtual void* getCustomContext | ( | const char * | key | ) |
| inlinevirtual

## ◆ getScreenCaptureSources()

virtual void* getScreenCaptureSources | ( | const ScreenSourceListOption & | option | ) |
| inlinevirtual

## ◆ setFrameCopy()

virtual void setFrameCopy | ( | bool | frameCopy | ) |
| inlinevirtual

## ◆ AddRef()

virtual void AddRef | ( |  | ) | const
| pure virtualinherited

## ◆ Release()

virtual RefCountReleaseStatus Release | ( |  | ) | const
| pure virtualinherited

## ◆ HasOneRef()

virtual bool HasOneRef | ( |  | ) | const
| pure virtualinherited