A listener class that groups together the callbacks related to a session. More...

#include <ZoomVideoSDKDelegate.h>

Inherits <NSObject>.

Instance Methods
(void)	- onSessionJoin
	Callback event when the current user joins the session.

(void)	- onSessionLeave
	Callback event when the current user leaves the session.

(void)	- onSessionLeave:
	Callback event when the current user leaves the session with reason.

(void)	- onError:detail:
	Callback event when errors occur.

(void)	- onUserJoin:users:
	Callback event when a user joins the session.

(void)	- onUserLeave:users:
	Callback event when a user leaves the session.

(void)	- onUserVideoStatusChanged:user:
	Callback event when a user makes changes to their video, such as starting or stopping their video.

(void)	- onUserAudioStatusChanged:user:
	Callback event when a user makes changes to their audio, such as muting or unmuting their audio.

(void)	- onUserShareStatusChanged:user:shareAction:
	Callback event when a user makes changes to their sharing status, such as starting screen sharing, starting view sharing, or stopping sharing.

(void)	- onFailedToStartShare:user:
	Callback event when a user fails to start sharing.

(void)	- onShareSettingChanged:
	Callback event when the share setting changes.

(void)	- onLiveStreamStatusChanged:status:
	Callback event when a user makes changes to their live stream status.

(void)	- onChatPrivilegeChanged:privilege:
	Callback event when the chat privilege of participant has changed.

(void)	- onChatNewMessageNotify:message:
	Callback event when receiving a chat message.

(void)	- onChatMsgDeleteNotification:messageID:deleteBy:
	Callback event when a user deletes a chat message.

(void)	- onUserHostChanged:users:
	Callback event when the session host changes.

(void)	- onUserManagerChanged:
	Callback event when the manager of the session changes.

(void)	- onUserNameChanged:
	Callback event when a user changes their name.

(void)	- onUserActiveAudioChanged:users:
	Callback event when the active audio changes.

(void)	- onSessionNeedPassword:
	Callback event when the session requires a password to join.

(void)	- onSessionPasswordWrong:
	Callback event when the provided session password is wrong or invalid.

(void)	- onMixedAudioRawDataReceived:
	Callback event when mixed (all users) audio raw data is received.

(void)	- onOneWayAudioRawDataReceived:user:
	Callback event when individual user's audio raw data is received.

(void)	- onSharedAudioRawDataReceived:
	Callback event when receiving shared raw audio data.

(void)	- onInviteByPhoneStatus:failReason:
	Callback event when the invite by phone status changes to any other valid status such as Calling, Ringing, Success, or Failed.

(void)	- onCalloutJoinSuccess:phoneNumber:
	Callback event when the invite by phone user joined session successfully.

(void)	- onCmdChannelConnectResult:
	Callback event when the command channel is ready to be used. When the SDK attempts to establish a connection for the command channel when joining a session, this callback is triggered once the connection attempt for the command channel is completed.

(void)	- onCommandReceived:sendUser:
	Callback event when receiving a message, data, or a command from the command channel. Once the command channel is active, this callback is triggered each time a message is received.

(void)	- onCameraControlRequestResult:approved:
	Callback event when the current user is granted camera control access.

(void)	- onCloudRecordingStatus:recordAgreementHandler:
	Callback event when cloud recording status has started, paused, stopped, resumed, or otherwise changed.

(void)	- onUserRecordAgreementNotification:
	Callback event when user agreement status changes.

(void)	- onHostAskUnmute
	Callback event when a host requests you to unmute yourself.

(void)	- onMultiCameraStreamStatusChanged:parentUser:videoPipe:
	Callback event when someone in a given session enables or disables multi-camera. All participants in the session receive this callback.

(void)	- onMultiCameraStreamStatusChanged:parentUser:videoCanvas:
	Callback event when someone enables or disables multi-camera. This callback is received by all participants.

(void)	- onTestMicStatusChanged:
	Callback event when the mic status changes during testing.

(void)	- onMicSpeakerVolumeChanged:speakerVolume:
	Callback event when the current mic or speaker volume changes during testing.

(void)	- onAudioLevelChanged:audioSharing:user:
	Callback event when the audio level of participants changes.

(void)	- onSystemPermissionRequired:
	Callback event when the SDK requires system permissions to continue functioning.

(void)	- onLiveTranscriptionStatus:
	Callback event when live transcription status changes.

(void)	- onLiveTranscriptionMsgReceived:
	Callback event when a live transcription message is received.

(void)	- onOriginalLanguageMsgReceived:
	Callback event when an original language message is received.

(void)	- onLiveTranscriptionMsgError:transLanguage:
	Callback event when a live translation error occurs.

(void)	- onSpokenLanguageChanged:
	Callback event when the spoken language has changed.

(void)	- onProxySettingNotification:
	Callback event when the proxy requests to input the username and password. Use the handler to configure the related information.

(void)	- onSSLCertVerifiedFailNotification:
	Callback event when the SSL is verified. Use the handler to check the related information.

(void)	- onUserVideoNetworkStatusChanged:user:
	Callback event when a user's network status changes (Lite SDK only).

(void)	- onUserShareNetworkStatusChanged:isSending:
	Callback event when the current user's share network quality changes.

(void)	- onUserNetworkStatusChanged:level:user:
	Callback event when the user's network quality changes.

(void)	- onUserOverallNetworkStatusChanged:user:
	Callback event when a user's overall network status changes.

(void)	- onCallCRCDeviceStatusChanged:
	Callback event of the call CRC device's status.

(void)	- onAnnotationHelperCleanUp:
	Callback event when the annotation helper is cleaned up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.

(void)	- onAnnotationPrivilegeChange:shareOwner:
	Callback event when the annotation privilege changes.

(void)	- onAnnotationPrivilegeChangeWithUser:shareAction:
	Callback event when the annotation privilege changes.

(void)	- onAnnotationToolTypeChanged:view:toolType:
	Callback event when the annotation tool type changes.

(void)	- onShareContentChanged:user:shareAction:
	Callback event when a user makes changes to their share content type, such as switching camera share to normal share. Find the share type in ZoomVideoSDKShareType.

(void)	- onShareCaptureSizeChanged:user:shareAction:
	Callback event when the size of a user's share capture changes.

(void)	- onVideoCanvasSubscribeFail:user:view:
	Callback event for the subscribed user's video fail reason.

(void)	- onShareCanvasSubscribeFail:user:view:
	Callback event for the subscribed user's share fail reason.

(void)	- onShareCanvasSubscribeFailWithUser:view:shareAction:
	Callback event for the share canvas that failed to subscribe.

(void)	- onSendFileStatus:status:
	Callback event when send file status changes.

(void)	- onReceiveFileStatus:status:
	Callback event when receive file status changes.

(void)	- onVideoAlphaChannelStatusChanged:
	Callback event when video alpha channel mode changes.

(void)	- onSpotlightVideoChanged:userList:
	Callback event when spotlighted video user changes.

(void)	- onBindIncomingLiveStreamResponse:success:streamKeyID:
	Callback event when binding the incoming live stream.

(void)	- onUnbindIncomingLiveStreamResponse:success:streamKeyID:
	Callback event when unbinding the incoming live stream.

(void)	- onIncomingLiveStreamStatusResponse:success:streamsStatusList:
	Callback event when getting the streams status.

(void)	- onStartIncomingLiveStreamResponse:success:streamKeyID:
	Callback event when starting the bound stream.

(void)	- onStopIncomingLiveStreamResponse:success:streamKeyID:
	Callback event when stopping the bound stream.

(void)	- onShareContentSizeChanged:user:shareAction:
	Callback event when the share content size has changed.

(void)	- onUVCCameraStatusChange:
	Callback event when the external UVC camera status changes.

(void)	- onSubSessionStatusChanged:subSession:
	Callback event when the SubSession status changes.

(void)	- onSubSessionManagerHandle:
	Callback event when the user has SubSession manager privilege.

(void)	- onSubSessionParticipantHandle:
	Callback event when the user has SubSession attendee privilege.

(void)	- onSubSessionUsersUpdate:
	Callback event when the users of a SubSession have updated.

(void)	- onBroadcastMessageFromMainSession:userName:
	Callback event when the user receives the main session broadcast message.

(void)	- onSubSessionUserHelpRequestHandler:
	Callback event when the user receives the help request from SubSession.

(void)	- onSubSessionUserHelpRequestResult:
	Callback event when the result of help request is received.

(void)	- onMyAudioSourceTypeChanged:
	Callback event when the current user's audio source changes.

(void)	- onInAppScreenShareErrorCode:
	Callback event when in-app screen sharing session encounters an error or success.

(void)	- onInAppScreenShareAvailableChanged:
	Callback event when the availability of in-app screen sharing changes. Use this callback to enable or disable screen sharing controls in your UI based on current availability.

(void)	- onStartBroadcastResponse:channelID:
	Callback event when the response of broadcast streaming is received.

(void)	- onStopBroadcastResponse:
	Callback event when the response of broadcast streaming is received.

(void)	- onGetBroadcastControlStatus:status:
	Callback event when the response that gets broadcast status is received.

(void)	- onStreamingJoinStatusChanged:
	Callback event when the viewer's join status changes.

(void)	- onWhiteboardExported:data:
	Callback event when a whiteboard file export completes.

(void)	- onUserWhiteboardShareStatusChanged:whiteboardhelper:
	Callback event when a user changes their whiteboard sharing status, such as starting or stopping whiteboard sharing.

(void)	- onCanvasSnapshotTaken:isShare:
	Callback invoked when a canvas snapshot is successfully taken.

(void)	- onCanvasSnapshotIncompatible:
	Callback invoked when a canvas snapshot is attempted but cannot be taken due to compatibility issues with the target user.

(void)	- onRealTimeMediaStreamsStatus:
	Callback event when the real-time media stream's status changes.

(void)	- onRealTimeMediaStreamsFail:
	Callback event when the real-time media stream failure reason is received.

Detailed Description

A listener class that groups together the callbacks related to a session.

Definition at line 39 of file ZoomVideoSDKDelegate.h.

Method Documentation

◆ onAnnotationHelperCleanUp:

- (void) onAnnotationHelperCleanUp: (ZoomVideoSDKAnnotationHelper *_Nullable) helper

optionalrequired

Callback event when the annotation helper is cleaned up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.

Parameters

helper The helper cleanup object.

◆ onAnnotationPrivilegeChange:shareOwner:

- (void) onAnnotationPrivilegeChange:		(BOOL)	enable
shareOwner:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when the annotation privilege changes.

Parameters

enable	YES if the user is able to annotate, NO if the user is not able to annotate.
user	The user who changed viewer's annotation privilege.

Deprecated: Use onAnnotationPrivilegeChangeWithUser:shareAction:] instead.

◆ onAnnotationPrivilegeChangeWithUser:shareAction:

- (void) onAnnotationPrivilegeChangeWithUser:		(ZoomVideoSDKUser *_Nullable)	user
shareAction:		(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event when the annotation privilege changes.

Parameters

user	The user object who changed viewer's annotation privilege.
shareAction	The share object.

◆ onAnnotationToolTypeChanged:view:toolType:

- (void) onAnnotationToolTypeChanged:	(ZoomVideoSDKAnnotationHelper *_Nullable)	helper
view:	(UIView *_Nullable)	view
toolType:	(ZoomVideoSDKAnnotationToolType)	toolType

optionalrequired

Callback event when the annotation tool type changes.

Parameters

helper	The helper cleanup object.
view	The view that is annotating.
toolType	The new annotation tool type currently selected.

◆ onAudioLevelChanged:audioSharing:user:

- (void) onAudioLevelChanged:	(NSUInteger)	level
audioSharing:	(BOOL)	bAudioSharing
user:	(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when the audio level of participants changes.

Parameters

level	The current audio level of the user, in the range [0, 9].
bAudioSharing	YES if the audio level is from shared audio, such as computer audio, NO if it's from the microphone.
user	The user whose audio level has changed.

◆ onBindIncomingLiveStreamResponse:success:streamKeyID:

- (void) onBindIncomingLiveStreamResponse:	(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	helper
success:	(BOOL)	success
streamKeyID:	(NSString *_Nullable)	streamKeyID

optionalrequired

Callback event when binding the incoming live stream.

Parameters

helper	The incoming live stream helper utility.
success	YES if success, NO otherwise.
streamKeyID	The corresponding stream key ID.

◆ onBroadcastMessageFromMainSession:userName:

- (void) onBroadcastMessageFromMainSession:		(NSString *_Nonnull)	sMessage
userName:		(NSString *_Nonnull)	sUserName

optionalrequired

Callback event when the user receives the main session broadcast message.

Parameters

sMessage	The message content.
sUserName	The name of the user who broadcast this message.

◆ onCallCRCDeviceStatusChanged:

- (void) onCallCRCDeviceStatusChanged: (ZoomVideoSDKCRCCallStatus) state

optionalrequired

Callback event of the call CRC device's status.

Parameters

state The call out status.

◆ onCalloutJoinSuccess:phoneNumber:

- (void) onCalloutJoinSuccess:		(ZoomVideoSDKUser *_Nullable)	user
phoneNumber:		(NSString *_Nullable)	phoneNumber

optionalrequired

Callback event when the invite by phone user joined session successfully.

Parameters

user	The successfully joined user.
phoneNumber	The phone number of callout.

◆ onCameraControlRequestResult:approved:

- (void) onCameraControlRequestResult:		(ZoomVideoSDKUser *_Nullable)	user
approved:		(BOOL)	isApproved

optionalrequired

Callback event when the current user is granted camera control access.

Parameters

user	The user who received the request.
isApproved	The result of the camera control request.

Note: Once the current user sends the camera control request, this callback will be triggered with the result of the request.

◆ onCanvasSnapshotIncompatible:

- (void) onCanvasSnapshotIncompatible: (ZoomVideoSDKUser *_Nonnull) user

optionalrequired

Callback invoked when a canvas snapshot is attempted but cannot be taken due to compatibility issues with the target user.

Parameters

user	The target user whose snapshot could not be taken due to compatibility issues.

◆ onCanvasSnapshotTaken:isShare:

- (void) onCanvasSnapshotTaken:		(ZoomVideoSDKUser *_Nonnull)	user
isShare:		(BOOL)	isShare

optionalrequired

Callback invoked when a canvas snapshot is successfully taken.

Parameters

user	The user who took the snapshot.
isShare	YES if the snapshot is of shared content; NO if it is of video content.

◆ onChatMsgDeleteNotification:messageID:deleteBy:

- (void) onChatMsgDeleteNotification:	(ZoomVideoSDKChatHelper *_Nullable)	helper
messageID:	(NSString *_Nonnull)	msgID
deleteBy:	(ZoomVideoSDKChatMsgDeleteBy)	type

optionalrequired

Callback event when a user deletes a chat message.

Parameters

helper	The chat helper utility.
msgID	The deleted message's ID.
type	Indicates by whom the message was deleted, which is defined in [ZoomVideoSDKChatMsgDeleteBy].

◆ onChatNewMessageNotify:message:

- (void) onChatNewMessageNotify:		(ZoomVideoSDKChatHelper *_Nullable)	helper
message:		(ZoomVideoSDKChatMessage *_Nullable)	chatMessage

optionalrequired

Callback event when receiving a chat message.

Parameters

helper	The chat helper utility.
chatMessage	The object which contains the message content.

◆ onChatPrivilegeChanged:privilege:

- (void) onChatPrivilegeChanged:		(ZoomVideoSDKChatHelper *_Nullable)	helper
privilege:		(ZoomVideoSDKChatPrivilegeType)	currentPrivilege

optionalrequired

Callback event when the chat privilege of participant has changed.

Parameters

helper	The chat helper utility.
currentPrivilege	The new chat privilege.

◆ onCloudRecordingStatus:recordAgreementHandler:

- (void) onCloudRecordingStatus:		(ZoomVideoSDKRecordingStatus)	status
recordAgreementHandler:		(ZoomVideoSDKRecordAgreementHandler *_Nullable)	handler

optionalrequired

Callback event when cloud recording status has started, paused, stopped, resumed, or otherwise changed.

Parameters

status	The cloud recording status.
handler	The handler that can handle the action user Accept or Decline.

◆ onCmdChannelConnectResult:

- (void) onCmdChannelConnectResult: (BOOL) success

optionalrequired

Callback event when the command channel is ready to be used. When the SDK attempts to establish a connection for the command channel when joining a session, this callback is triggered once the connection attempt for the command channel is completed.

Parameters

success YES if the command channel is ready to be used. NO if the command channel was unable to connect.

◆ onCommandReceived:sendUser:

- (void) onCommandReceived:		(NSString *_Nullable)	commandContent
sendUser:		(ZoomVideoSDKUser *_Nullable)	sendUser

optionalrequired

Callback event when receiving a message, data, or a command from the command channel. Once the command channel is active, this callback is triggered each time a message is received.

Parameters

commandContent	The received command.
sendUser	The user who sent the command.

◆ onError:detail:

- (void) onError:		(ZoomVideoSDKError)	ErrorType
detail:		(NSInteger)	details

optionalrequired

Callback event when errors occur.

Parameters

ErrorType	The error code associated with the error.
details	The detail of error message.

◆ onFailedToStartShare:user:

- (void) onFailedToStartShare:		(ZoomVideoSDKShareHelper *_Nonnull)	helper
user:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when a user fails to start sharing.

Parameters

helper	The share helper object.
user	The user object.

◆ onGetBroadcastControlStatus:status:

- (void) onGetBroadcastControlStatus:		(BOOL)	isSuccess
status:		(ZoomVideoSDKBroadcastControlStatus)	status

optionalrequired

Callback event when the response that gets broadcast status is received.

Parameters

isSuccess	YES if the request succeeded, NO otherwise.
status	The current broadcast status.

◆ onHostAskUnmute

- (void) onHostAskUnmute

optionalrequired

Callback event when a host requests you to unmute yourself.

◆ onInAppScreenShareAvailableChanged:

- (void) onInAppScreenShareAvailableChanged: (BOOL) available

optionalrequired

Callback event when the availability of in-app screen sharing changes. Use this callback to enable or disable screen sharing controls in your UI based on current availability.

Parameters

available YES if available, NO otherwise.

◆ onInAppScreenShareErrorCode:

- (void) onInAppScreenShareErrorCode: (RPRecordingErrorCode) code

optionalrequired

Callback event when in-app screen sharing session encounters an error or success.

Parameters

code	The error code.

◆ onIncomingLiveStreamStatusResponse:success:streamsStatusList:

- (void) onIncomingLiveStreamStatusResponse:	(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	helper
success:	(BOOL)	success
streamsStatusList:	(NSArray< ZoomVideoSDKIncomingLiveStreamStatus * > *_Nullable)	streamsStatusList

optionalrequired

Callback event when getting the streams status.

Parameters

helper	The incoming live stream helper utility.
success	YES if success, NO otherwise.
streamsStatusList	The streams status list.

◆ onInviteByPhoneStatus:failReason:

- (void) onInviteByPhoneStatus:		(ZoomVideoSDKPhoneStatus)	status
failReason:		(ZoomVideoSDKPhoneFailedReason)	failReason

optionalrequired

Callback event when the invite by phone status changes to any other valid status such as Calling, Ringing, Success, or Failed.

Parameters

status	The invite by phone status.
failReason	The invite by phone failed reason.

◆ onLiveStreamStatusChanged:status:

- (void) onLiveStreamStatusChanged:		(ZoomVideoSDKLiveStreamHelper *_Nullable)	helper
status:		(ZoomVideoSDKLiveStreamStatus)	status

optionalrequired

Callback event when a user makes changes to their live stream status.

Parameters

helper	The live stream helper utility.
status	The live stream status.

◆ onLiveTranscriptionMsgError:transLanguage:

- (void) onLiveTranscriptionMsgError:		(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	spokenLanguage
transLanguage:		(ZoomVideoSDKLiveTranscriptionLanguage *_Nullable)	transcriptLanguage

optionalrequired

Callback event when a live translation error occurs.

Parameters

spokenLanguage	The spoken message language.
transcriptLanguage	The message language you want to translate.

◆ onLiveTranscriptionMsgReceived:

- (void) onLiveTranscriptionMsgReceived: (ZoomVideoSDKLiveTranscriptionMessageInfo *_Nullable) messageInfo

optionalrequired

Callback event when a live transcription message is received.

Parameters

messageInfo The live transcription message.

◆ onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus: (ZoomVideoSDKLiveTranscriptionStatus) status

optionalrequired

Callback event when live transcription status changes.

Parameters

status The live transcription status.

◆ onMicSpeakerVolumeChanged:speakerVolume:

- (void) onMicSpeakerVolumeChanged:		(int)	micVolume
speakerVolume:		(int)	speakerVolume

optionalrequired

Callback event when the current mic or speaker volume changes during testing.

Parameters

micVolume	The volume of the mic when testing or in session.
speakerVolume	The volume of the speaker when testing.

◆ onMixedAudioRawDataReceived:

- (void) onMixedAudioRawDataReceived: (ZoomVideoSDKAudioRawData *_Nullable) rawData

optionalrequired

Callback event when mixed (all users) audio raw data is received.

Parameters

rawData The audio raw data.

◆ onMultiCameraStreamStatusChanged:parentUser:videoCanvas:

- (void) onMultiCameraStreamStatusChanged:	(ZoomVideoSDKMultiCameraStreamStatus)	status
parentUser:	(ZoomVideoSDKUser *_Nullable)	user
videoCanvas:	(ZoomVideoSDKVideoCanvas *_Nullable)	videoCanvas

optionalrequired

Callback event when someone enables or disables multi-camera. This callback is received by all participants.

Parameters

status	The status for multiple camera user join or left.
user	The user who enabled multi-camera.
videoCanvas	The video canvas for the multi-camera.

◆ onMultiCameraStreamStatusChanged:parentUser:videoPipe:

- (void) onMultiCameraStreamStatusChanged:	(ZoomVideoSDKMultiCameraStreamStatus)	status
parentUser:	(ZoomVideoSDKUser *_Nullable)	user
videoPipe:	(ZoomVideoSDKRawDataPipe *_Nullable)	videoPipe

optionalrequired

Callback event when someone in a given session enables or disables multi-camera. All participants in the session receive this callback.

Parameters

status	The status for multiple camera user join or left.
user	The user who enabled multi-camera.
videoPipe	The data pipe for the multi-camera.

◆ onMyAudioSourceTypeChanged:

- (void) onMyAudioSourceTypeChanged: (ZoomVideoSDKAudioDevice *_Nullable) device

optionalrequired

Callback event when the current user's audio source changes.

Parameters

device The updated audio device.

◆ onOneWayAudioRawDataReceived:user:

- (void) onOneWayAudioRawDataReceived:		(ZoomVideoSDKAudioRawData *_Nullable)	rawData
user:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when individual user's audio raw data is received.

Parameters

rawData	The raw audio data.
user	The user who received the audio raw data.

◆ onOriginalLanguageMsgReceived:

- (void) onOriginalLanguageMsgReceived: (ZoomVideoSDKLiveTranscriptionMessageInfo *_Nullable) messageInfo

optionalrequired

Callback event when an original language message is received.

Parameters

messageInfo The spoken language message.

◆ onProxySettingNotification:

- (void) onProxySettingNotification: (ZoomVideoSDKProxySettingHandler *_Nonnull) handler

optionalrequired

Callback event when the proxy requests to input the username and password. Use the handler to configure the related information.

Parameters

handler The handler will be destroyed once the function calls end.

◆ onRealTimeMediaStreamsFail:

- (void) onRealTimeMediaStreamsFail: (ZoomVideoSDKRealTimeMediaStreamsFailReason) failReason

optionalrequired

Callback event when the real-time media stream failure reason is received.

Parameters

failReason The real-time media stream failure reason.

◆ onRealTimeMediaStreamsStatus:

- (void) onRealTimeMediaStreamsStatus: (ZoomVideoSDKRealTimeMediaStreamsStatus) status

optionalrequired

Callback event when the real-time media stream's status changes.

Parameters

status The real-time media streams status.

◆ onReceiveFileStatus:status:

- (void) onReceiveFileStatus:		(ZoomVideoSDKReceiveFile *_Nullable)	file
status:		(ZoomVideoSDKFileTransferStatus)	status

optionalrequired

Callback event when receive file status changes.

Parameters

file	The receive file object.
status	The status of file transfer.

◆ onSendFileStatus:status:

- (void) onSendFileStatus:		(ZoomVideoSDKSendFile *_Nullable)	file
status:		(ZoomVideoSDKFileTransferStatus)	status

optionalrequired

Callback event when send file status changes.

Parameters

file	The send file object.
status	The status of file transfer.

◆ onSessionJoin

- (void) onSessionJoin

optional

Callback event when the current user joins the session.

◆ onSessionLeave

- (void) onSessionLeave

optionalrequired

Callback event when the current user leaves the session.

Deprecated: Use onSessionLeave: instead.

◆ onSessionLeave:

- (void) onSessionLeave: (ZoomVideoSDKSessionLeaveReason) reason

optionalrequired

Callback event when the current user leaves the session with reason.

Parameters

reason The leave session reason.

◆ onSessionNeedPassword:

- (void) onSessionNeedPassword: (ZoomVideoSDKError(^)(NSString *_Nullable password, BOOL leaveSessionIgnorePassword)) completion

optionalrequired

Callback event when the session requires a password to join.

Parameters

completion The block for this callback.

◆ onSessionPasswordWrong:

- (void) onSessionPasswordWrong: (ZoomVideoSDKError(^)(NSString *_Nullable password, BOOL leaveSessionIgnorePassword)) completion

optionalrequired

Callback event when the provided session password is wrong or invalid.

Parameters

completion The block for this callback.

◆ onShareCanvasSubscribeFail:user:view:

- (void) onShareCanvasSubscribeFail:	(ZoomVideoSDKSubscribeFailReason)	failReason
user:	(ZoomVideoSDKUser *_Nullable)	user
view:	(UIView *_Nullable)	view

optionalrequired

Callback event for the subscribed user's share fail reason.

Parameters

failReason	The fail reason.
user	The pointer to the user whose view we would like to subscribe.
view	The view that failed to subscribe.

Deprecated: use -[ZoomVideoSDKDelegate onShareCanvasSubscribeFailWithUser:view:shareAction:] instead.

◆ onShareCanvasSubscribeFailWithUser:view:shareAction:

- (void) onShareCanvasSubscribeFailWithUser:	(ZoomVideoSDKUser *_Nullable)	user
view:	(UIView *_Nullable)	view
shareAction:	(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event for the share canvas that failed to subscribe.

Parameters

user	The pointer to the user object whose view we would like to subscribe to.
view	The view that failed to subscribe.
shareAction	The pointer to a share object.

◆ onShareCaptureSizeChanged:user:shareAction:

- (void) onShareCaptureSizeChanged:	(ZoomVideoSDKShareHelper *_Nullable)	shareHelper
user:	(ZoomVideoSDKUser *_Nullable)	user
shareAction:	(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event when the size of a user's share capture changes.

Parameters

shareHelper	The share helper object associated with the share.
user	The user whose share capture size has changed.
shareAction	The share action details, such as start, stop, or resize.

◆ onShareContentChanged:user:shareAction:

- (void) onShareContentChanged:	(ZoomVideoSDKShareHelper *_Nullable)	shareHelper
user:	(ZoomVideoSDKUser *_Nullable)	user
shareAction:	(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event when a user makes changes to their share content type, such as switching camera share to normal share. Find the share type in ZoomVideoSDKShareType.

Parameters

shareHelper	The share helper utility.
user	The current start or stop share user.
shareAction	The share object.

◆ onShareContentSizeChanged:user:shareAction:

- (void) onShareContentSizeChanged:	(ZoomVideoSDKShareHelper *_Nullable)	helper
user:	(ZoomVideoSDKUser *_Nullable)	user
shareAction:	(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event when the share content size has changed.

Parameters

helper	The share helper object.
user	The user object whose share content size has changed.
shareAction	The ZoomVideoSDKShareAction object.

Note: A share content size change may occur in two cases: when the first frame of shared content is received (from no content to having a size), or when the content size actually changes during sharing.

◆ onSharedAudioRawDataReceived:

- (void) onSharedAudioRawDataReceived: (ZoomVideoSDKAudioRawData *_Nullable) rawData

optionalrequired

Callback event when receiving shared raw audio data.

Parameters

rawData The raw audio data.

◆ onShareSettingChanged:

- (void) onShareSettingChanged: (ZoomVideoSDKShareSetting) setting

optionalrequired

Callback event when the share setting changes.

Parameters

setting The share setting.

◆ onSpokenLanguageChanged:

- (void) onSpokenLanguageChanged: (ZoomVideoSDKLiveTranscriptionLanguage *_Nullable) spokenLanguage

optionalrequired

Callback event when the spoken language has changed.

Parameters

spokenLanguage The spoken message language.

◆ onSpotlightVideoChanged:userList:

- (void) onSpotlightVideoChanged:		(ZoomVideoSDKVideoHelper *_Nullable)	videoHelper
userList:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userList

optionalrequired

Callback event when spotlighted video user changes.

Parameters

videoHelper	The video helper object.
userList	The list of users who have been spotlighted.

◆ onSSLCertVerifiedFailNotification:

- (void) onSSLCertVerifiedFailNotification: (ZoomVideoSDKSSLCertificateInfo *_Nonnull) handler

optionalrequired

Callback event when the SSL is verified. Use the handler to check the related information.

Parameters

handler The handler will be destroyed once the function calls end.

◆ onStartBroadcastResponse:channelID:

- (void) onStartBroadcastResponse:		(BOOL)	isSuccess
channelID:		(NSString *_Nonnull)	channelID

optionalrequired

Callback event when the response of broadcast streaming is received.

Parameters

isSuccess	YES if broadcast streaming started successfully, NO otherwise.
channelID	The backend service to identify the broadcast streaming channel ID returned by the backend.

◆ onStartIncomingLiveStreamResponse:success:streamKeyID:

- (void) onStartIncomingLiveStreamResponse:	(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	helper
success:	(BOOL)	success
streamKeyID:	(NSString *_Nullable)	streamKeyID

optionalrequired

Callback event when starting the bound stream.

Parameters

helper	The incoming live stream helper utility.
success	YES if success, NO otherwise.
streamKeyID	The corresponding stream key ID.

◆ onStopBroadcastResponse:

- (void) onStopBroadcastResponse: (BOOL) isSuccess

optionalrequired

Callback event when the response of broadcast streaming is received.

Parameters

isSuccess YES if broadcast stopped successfully, NO otherwise.

◆ onStopIncomingLiveStreamResponse:success:streamKeyID:

- (void) onStopIncomingLiveStreamResponse:	(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	helper
success:	(BOOL)	success
streamKeyID:	(NSString *_Nullable)	streamKeyID

optionalrequired

Callback event when stopping the bound stream.

Parameters

helper	The incoming live stream helper utility.
success	YES if success, NO otherwise.
streamKeyID	The corresponding stream key ID.

◆ onStreamingJoinStatusChanged:

- (void) onStreamingJoinStatusChanged: (ZoomVideoSDKStreamingJoinStatus) status

optionalrequired

Callback event when the viewer's join status changes.

Parameters

status The current join status.

◆ onSubSessionManagerHandle:

- (void) onSubSessionManagerHandle: (ZoomVideoSDKSubSessionManager *_Nullable) pManager

optionalrequired

Callback event when the user has SubSession manager privilege.

Parameters

pManager The SubSession manager object.

◆ onSubSessionParticipantHandle:

- (void) onSubSessionParticipantHandle: (ZoomVideoSDKSubSessionParticipant *_Nullable) pParticipant

optionalrequired

Callback event when the user has SubSession attendee privilege.

Parameters

pParticipant The SubSession attendee object.

◆ onSubSessionStatusChanged:subSession:

- (void) onSubSessionStatusChanged:		(ZoomVideoSDKSubSessionStatus)	status
subSession:		(NSArray< ZoomVideoSDKSubSessionKit * > *_Nonnull)	pSubSessionKitList

optionalrequired

Callback event when the SubSession status changes.

Parameters

status	The SubSession status.
pSubSessionKitList	The new SubSession list.

◆ onSubSessionUserHelpRequestHandler:

- (void) onSubSessionUserHelpRequestHandler: (ZoomVideoSDKSubSessionUserHelpRequestHandler *_Nonnull) pHandler

optionalrequired

Callback event when the user receives the help request from SubSession.

Parameters

pHandler The request handler object.

◆ onSubSessionUserHelpRequestResult:

- (void) onSubSessionUserHelpRequestResult: (ZoomVideoSDKUserHelpRequestResult) result

optionalrequired

Callback event when the result of help request is received.

Parameters

result The result of help request.

◆ onSubSessionUsersUpdate:

- (void) onSubSessionUsersUpdate: (ZoomVideoSDKSubSessionKit *_Nonnull) pSubSessionKit

optionalrequired

Callback event when the users of a SubSession have updated.

Parameters

pSubSessionKit The SubSession kit object.

◆ onSystemPermissionRequired:

- (void) onSystemPermissionRequired: (ZoomVideoSDKSystemPermissionType) permissionType

optionalrequired

Callback event when the SDK requires system permissions to continue functioning.

Parameters

permissionType The type of system permission that is required.

◆ onTestMicStatusChanged:

- (void) onTestMicStatusChanged: (ZoomVideoSDKTestMicStatus) status

optionalrequired

Callback event when the mic status changes during testing.

Parameters

status The mic status.

◆ onUnbindIncomingLiveStreamResponse:success:streamKeyID:

- (void) onUnbindIncomingLiveStreamResponse:	(ZoomVideoSDKIncomingLiveStreamHelper *_Nullable)	helper
success:	(BOOL)	success
streamKeyID:	(NSString *_Nullable)	streamKeyID

optionalrequired

Callback event when unbinding the incoming live stream.

Parameters

helper	The incoming live stream helper utility.
success	YES if success, NO otherwise.
streamKeyID	The corresponding stream key ID.

◆ onUserActiveAudioChanged:users:

- (void) onUserActiveAudioChanged:		(ZoomVideoSDKUserHelper *_Nullable)	helper
users:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback event when the active audio changes.

Parameters

helper	The audio helper utility.
userArray	The active audio list.

◆ onUserAudioStatusChanged:user:

- (void) onUserAudioStatusChanged:		(ZoomVideoSDKAudioHelper *_Nullable)	helper
user:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback event when a user makes changes to their audio, such as muting or unmuting their audio.

Parameters

helper	The audio helper utility.
userArray	The list of users whose audio status has changed.

◆ onUserHostChanged:users:

- (void) onUserHostChanged:		(ZoomVideoSDKUserHelper *_Nullable)	helper
users:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when the session host changes.

Parameters

helper	The user helper utility.
user	The host user.

◆ onUserJoin:users:

- (void) onUserJoin:		(ZoomVideoSDKUserHelper *_Nullable)	helper
users:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback event when a user joins the session.

Parameters

helper	The user helper utility.
userArray	The list of users who have just joined the session.

◆ onUserLeave:users:

- (void) onUserLeave:		(ZoomVideoSDKUserHelper *_Nullable)	helper
users:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback event when a user leaves the session.

Parameters

helper	The user helper utility.
userArray	The list of users who have just left the session.

◆ onUserManagerChanged:

- (void) onUserManagerChanged: (ZoomVideoSDKUser *_Nullable) user

optionalrequired

Callback event when the manager of the session changes.

Parameters

user	The manager user.

◆ onUserNameChanged:

- (void) onUserNameChanged: (ZoomVideoSDKUser *_Nullable) user

optionalrequired

Callback event when a user changes their name.

Parameters

user	The user who changed their name.

◆ onUserNetworkStatusChanged:level:user:

- (void) onUserNetworkStatusChanged:	(ZoomVideoSDKDataType)	type
level:	(ZoomVideoSDKNetworkStatus)	level
user:	(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when the user's network quality changes.

Parameters

type	The data type whose network status changed.
level	The new network quality level for the specified data type.
user	The user whose network status has changed.

◆ onUserOverallNetworkStatusChanged:user:

- (void) onUserOverallNetworkStatusChanged:		(ZoomVideoSDKNetworkStatus)	level
user:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when a user's overall network status changes.

Parameters

level	The new overall network quality level.
user	The user whose overall network status has changed.

◆ onUserRecordAgreementNotification:

- (void) onUserRecordAgreementNotification: (ZoomVideoSDKUser *_Nullable) user

optionalrequired

Callback event when user agreement status changes.

Parameters

user	The user which agreed to the record.

◆ onUserShareNetworkStatusChanged:isSending:

- (void) onUserShareNetworkStatusChanged:		(ZoomVideoSDKNetworkStatus)	shareNetworkStatus
isSending:		(BOOL)	isSendingShare

optionalrequired

Callback event when the current user's share network quality changes.

Parameters

shareNetworkStatus	The share network quality.
isSendingShare	YES if it refers to the sending share, NO if it refers to the receiving share.

Deprecated: Use onUserNetworkStatusChanged:level:user: instead.

◆ onUserShareStatusChanged:user:shareAction:

- (void) onUserShareStatusChanged:	(ZoomVideoSDKShareHelper *_Nullable)	helper
user:	(ZoomVideoSDKUser *_Nullable)	user
shareAction:	(ZoomVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event when a user makes changes to their sharing status, such as starting screen sharing, starting view sharing, or stopping sharing.

Parameters

helper	The share helper object.
user	The user object.
shareAction	The ZoomVideoSDKShareAction object.

◆ onUserVideoNetworkStatusChanged:user:

- (void) onUserVideoNetworkStatusChanged:		(ZoomVideoSDKNetworkStatus)	status
user:		(ZoomVideoSDKUser *_Nullable)	user

optionalrequired

Callback event when a user's network status changes (Lite SDK only).

Parameters

status	The user's network status.
user	The user whose network status has changed.

Deprecated: Use onUserNetworkStatusChanged:level:user: instead.

◆ onUserVideoStatusChanged:user:

- (void) onUserVideoStatusChanged:		(ZoomVideoSDKVideoHelper *_Nullable)	helper
user:		(NSArray< ZoomVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback event when a user makes changes to their video, such as starting or stopping their video.

Parameters

helper	The video helper utility.
userArray	The list of users whose video status has changed.

◆ onUserWhiteboardShareStatusChanged:whiteboardhelper:

- (void) onUserWhiteboardShareStatusChanged:		(ZoomVideoSDKUser *_Nonnull)	user
whiteboardhelper:		(ZoomVideoSDKWhiteboardHelper *_Nonnull)	whiteboardHelper

optionalrequired

Callback event when a user changes their whiteboard sharing status, such as starting or stopping whiteboard sharing.

Parameters

user	The user whose whiteboard sharing status changed.
whiteboardHelper	The whiteboard helper object.

◆ onUVCCameraStatusChange:

- (void) onUVCCameraStatusChange: (ZoomVideoSDKUVCCameraStatus) status

optionalrequired

Callback event when the external UVC camera status changes.

Parameters

status The UVC camera status.

Warning: Only iOS 17.0 or above and iPad device can receive this callback.

◆ onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged: (BOOL) isAlphaChannelOn

optionalrequired

Callback event when video alpha channel mode changes.

Parameters

isAlphaChannelOn YES if alpha channel mode is on, NO otherwise.

◆ onVideoCanvasSubscribeFail:user:view:

- (void) onVideoCanvasSubscribeFail:	(ZoomVideoSDKSubscribeFailReason)	failReason
user:	(ZoomVideoSDKUser *_Nullable)	user
view:	(UIView *_Nullable)	view

optionalrequired

Callback event for the subscribed user's video fail reason.

Parameters

failReason	The fail reason.
user	The pointer to the user whose view we would like to subscribe.
view	The view that failed to subscribe.

◆ onWhiteboardExported:data:

- (void) onWhiteboardExported:		(ZoomVideoSDKWhiteboardExportFormatType)	format
data:		(NSData *_Nonnull)	data

optionalrequired

Callback event when a whiteboard file export completes.

Parameters

format	The export format.
data	The export whiteboard data as NSData.

Instance Methods

Detailed Description

Method Documentation

◆ onAnnotationHelperCleanUp:

◆ onAnnotationPrivilegeChange:shareOwner:

◆ onAnnotationPrivilegeChangeWithUser:shareAction:

◆ onAnnotationToolTypeChanged:view:toolType:

◆ onAudioLevelChanged:audioSharing:user:

◆ onBindIncomingLiveStreamResponse:success:streamKeyID:

◆ onBroadcastMessageFromMainSession:userName:

◆ onCallCRCDeviceStatusChanged:

◆ onCalloutJoinSuccess:phoneNumber:

◆ onCameraControlRequestResult:approved:

◆ onCanvasSnapshotIncompatible:

◆ onCanvasSnapshotTaken:isShare:

◆ onChatMsgDeleteNotification:messageID:deleteBy:

◆ onChatNewMessageNotify:message:

◆ onChatPrivilegeChanged:privilege:

◆ onCloudRecordingStatus:recordAgreementHandler:

◆ onCmdChannelConnectResult:

◆ onCommandReceived:sendUser:

◆ onError:detail:

◆ onFailedToStartShare:user:

◆ onGetBroadcastControlStatus:status:

◆ onHostAskUnmute

◆ onInAppScreenShareAvailableChanged:

◆ onInAppScreenShareErrorCode:

◆ onIncomingLiveStreamStatusResponse:success:streamsStatusList:

◆ onInviteByPhoneStatus:failReason:

◆ onLiveStreamStatusChanged:status:

◆ onLiveTranscriptionMsgError:transLanguage:

◆ onLiveTranscriptionMsgReceived:

◆ onLiveTranscriptionStatus:

◆ onMicSpeakerVolumeChanged:speakerVolume:

◆ onMixedAudioRawDataReceived:

◆ onMultiCameraStreamStatusChanged:parentUser:videoCanvas:

◆ onMultiCameraStreamStatusChanged:parentUser:videoPipe:

◆ onMyAudioSourceTypeChanged:

◆ onOneWayAudioRawDataReceived:user:

◆ onOriginalLanguageMsgReceived:

◆ onProxySettingNotification:

◆ onRealTimeMediaStreamsFail:

◆ onRealTimeMediaStreamsStatus:

◆ onReceiveFileStatus:status:

◆ onSendFileStatus:status:

◆ onSessionJoin

◆ onSessionLeave

◆ onSessionLeave:

◆ onSessionNeedPassword:

◆ onSessionPasswordWrong:

◆ onShareCanvasSubscribeFail:user:view:

◆ onShareCanvasSubscribeFailWithUser:view:shareAction:

◆ onShareCaptureSizeChanged:user:shareAction:

◆ onShareContentChanged:user:shareAction:

◆ onShareContentSizeChanged:user:shareAction:

◆ onSharedAudioRawDataReceived:

◆ onShareSettingChanged:

◆ onSpokenLanguageChanged:

◆ onSpotlightVideoChanged:userList:

◆ onSSLCertVerifiedFailNotification:

◆ onStartBroadcastResponse:channelID:

◆ onStartIncomingLiveStreamResponse:success:streamKeyID:

◆ onStopBroadcastResponse:

◆ onStopIncomingLiveStreamResponse:success:streamKeyID:

◆ onStreamingJoinStatusChanged:

◆ onSubSessionManagerHandle:

◆ onSubSessionParticipantHandle:

◆ onSubSessionStatusChanged:subSession:

◆ onSubSessionUserHelpRequestHandler:

◆ onSubSessionUserHelpRequestResult:

◆ onSubSessionUsersUpdate:

◆ onSystemPermissionRequired:

◆ onTestMicStatusChanged:

◆ onUnbindIncomingLiveStreamResponse:success:streamKeyID:

◆ onUserActiveAudioChanged:users:

◆ onUserAudioStatusChanged:user:

◆ onUserHostChanged:users:

◆ onUserJoin:users:

◆ onUserLeave:users:

◆ onUserManagerChanged: