logo
On this page

ZegoScreenCaptureConfig

ZegoScreenCaptureConfig

Screen capture configuration parameters.

Declared in ZegoExpressDefines.h

Properties

captureVideo

captureVideo
nonatomic, assign BOOL captureVideo

Whether to capture video when screen capture. The default is true.

captureAudio

captureAudio
nonatomic, assign BOOL captureAudio

Whether to capture audio when screen capture. The default is true.

microphoneVolume

microphoneVolume
nonatomic, assign unsigned int microphoneVolume

Set Microphone audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS)

applicationVolume

applicationVolume
nonatomic, assign unsigned int applicationVolume

Set Application audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS and Android)

cropRect

cropRect
nonatomic, assign CGRect cropRect

Set the crop rectangle during screen capture. The crop rectangle must be included in the rectangle of the original data, unit is pixel. (only for iOS/Android)

orientation

orientation
nonatomic, assign ZegoScreenCaptureOrientation orientation

Set the capture orientation of the screen capture. The capture orientation will be fixed, ignoring the system returned orientation. (only for iOS/Android)

muteExtensMicrophone

muteExtensMicrophone
nonatomic, assign BOOL muteExtensMicrophone

Set whether to mute the microphone of the extension process. The default is false. (only for iOS)

audioDeviceMode

audioDeviceMode
nonatomic, assign ZegoScreenCaptureAudioDeviceMode audioDeviceMode

Set the audio device mode for the specified scene, the default is None. (only for iOS) s:

  1. Only works when the audio main source is always a microphone;
  2. Only works for [startScreenCapture] interface, [updateScreenCapture] does not take effect;
  3. The audio device mode changes during screen capture may cause the audio output of the screen capture to be abnormal, which can be monitored through [onMobileScreenCaptureExceptionOccurred] callback, and if necessary, the screen capture needs to be restarted.;
  4. After the screen capture is stopped, the audio device mode before the screen capture will be restored.

Previous

zegoscreencaptureaudioconfig

Next

zegoscreencapturesource

On this page

Back to top