ZegoScreenCaptureSourceEventHandler

Declared in ZegoExpressEventHandler.h

Methods

screenCapture:availableFrame:dataLength:param

- (void)screenCapture:(ZegoScreenCaptureSource *)source availableFrame:(const void *)data dataLength:(unsigned int)dataLength param:(ZegoVideoFrameParam *)param;

Callback for screen capture data

Declared in ZegoExpressEventHandler.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	Callback screen capture source object.
data	const void *	The screen captures the data of the image frame (eg: RGBA only needs to consider data[0], I420 needs to consider data[0,1,2]).
dataLength	unsigned int	Data length (eg: RGBA only needs to consider dataLength[0], I420 needs to consider dataLength[0,1,2]).
param	ZegoVideoFrameParam *	Screen capture image frame parameters.

Details

Callback for screen capture data.

Trigger: This callback is fired after the screen starts capturing [startCapture].
Caution: The callback does not actually take effect until call [setEventHandler] to set.

Available since: 3.1.0

screenCapture:exceptionOccurred

- (void)screenCapture:(ZegoScreenCaptureSource *)source exceptionOccurred:(ZegoScreenCaptureSourceExceptionType)exceptionType;

The callback triggered when a screen capture source exception occurred

Declared in ZegoExpressEventHandler.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	Callback screen capture source object.
exceptionType	ZegoScreenCaptureSourceExceptionType	Capture source exception type.

Details

The callback triggered when a screen capture source exception occurred.

Trigger: This callback is triggered when an exception occurs after the screen start capture.
Caution: The callback does not actually take effect until call [setEventHandler] to set.

Available since: 3.1.0
Restrictions: Only available on Windows/macOS.

screenCapture:captureType:exceptionOccurred

- (void)screenCapture:(ZegoScreenCaptureSource *)source captureType:(ZegoScreenCaptureSourceType)sourceType exceptionOccurred:(ZegoScreenCaptureSourceExceptionType)exceptionType;

The callback triggered when a screen capture source capture type exception occurred

Declared in ZegoExpressEventHandler.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	Callback screen capture source object.
sourceType	ZegoScreenCaptureSourceType	Capture source type.
exceptionType	ZegoScreenCaptureSourceExceptionType	Capture source exception type.

Details

The callback triggered when a screen capture source capture type exception occurred.

Trigger: This callback is triggered when an exception occurs after the screen start capture.
Caution: The callback does not actually take effect until call [setEventHandler] to set.

Available since: 3.21.0
Restrictions: Only available on Windows/macOS.

screenCapture:windowState:windowRect

- (void)screenCapture:(ZegoScreenCaptureSource *)source windowState:(ZegoScreenCaptureWindowState)windowState windowRect:(CGRect)windowRect;

The callback will be triggered when the state of the capture target window change.

Declared in ZegoExpressEventHandler.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	Callback screen capture source object.
windowState	ZegoScreenCaptureWindowState	Capture window state.
windowRect	ZegoRect	Capture window rect.

Caution: The callback does not actually take effect until call [setEventHandler] to set.

Available since: 3.4.0
Restrictions: Only available on Windows/macOS.

screenCapture:rectChanged

- (void)screenCapture:(ZegoScreenCaptureSource *)source rectChanged:(CGRect)rect;

The callback will be triggered when the state of the capture target window change.

Declared in ZegoExpressEventHandler.h

Parameters

Name	Type	Description
source	ZegoScreenCaptureSource *	Callback screen capture source object.
rect	ZegoRect	Capture source rect.

Caution: The callback does not actually take effect until call [setEventHandler] to set.

Available since: 3.7.0
Restrictions: Only available on Windows/macOS.