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

#include <ZoomVideoSDKDelegate.h>

Inherits <NSObject>.

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

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

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

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

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

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

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

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

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

(void)	- onFailedToStartShare:user:
	Invoked when a user failed to start sharing.

(void)	- onShareSettingChanged:
	Notification of share setting changed.

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

(void)	- onChatPrivilegeChanged:privilege:
	The chat privilege of participant has changed.

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

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

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

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

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

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

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

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

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

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

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

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

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

(void)	- onCmdChannelConnectResult:
	Callback: Invoked 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: Invoked 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 for when the current user is granted camera control access.

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

(void)	- onUserRecordAgreementNotification:
	Callback: user agreement status change.

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

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

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

(void)	- onTestMicStatusChanged:
	Callback: Notify the mic status when testing.

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

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

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

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

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

(void)	- onOriginalLanguageMsgReceived:
	Callback: Original language message received callback.

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

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

(void)	- onProxySettingNotification:
	The callback will be triggered if the proxy requests to input the username and password.Use the handler to configure the related information.

(void)	- onSSLCertVerifiedFailNotification:
	The callback will be triggered when the SSL is verified.Use the handler to check the related information.

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

(void)	- onUserShareNetworkStatusChanged:isSending:
	Notification of the current user's share network quality changes.

(void)	- onUserNetworkStatusChanged:level:user:
	Called when the user's share 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 for the annotation helper clean up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.

(void)	- onAnnotationPrivilegeChange:shareOwner:
	Callback for the annotation privilege change.

(void)	- onAnnotationPrivilegeChangeWithUser:shareAction:
	Callback for the annotation privilege change.

(void)	- onShareContentChanged:user:shareAction:
	Callback: Invoked 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:

(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:
	Invoked when send file status make change.

(void)	- onReceiveFileStatus:status:
	Invoked when send file status make change.

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

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

(void)	- onBindIncomingLiveStreamResponse:success:streamKeyID:
	Callback event of binds the incoming live stream.

(void)	- onUnbindIncomingLiveStreamResponse:success:streamKeyID:
	Callback event of unbinds the incoming live stream.

(void)	- onIncomingLiveStreamStatusResponse:success:streamsStatusList:
	Callback event of gets the streams status.

(void)	- onStartIncomingLiveStreamResponse:success:streamKeyID:
	Callback event of starts the binded stream.

(void)	- onStopIncomingLiveStreamResponse:success:streamKeyID:
	Callback event of stops the binded stream.

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

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

(void)	- onSubSessionStatusChanged:subSession:
	Callback event that the SubSession status changed.

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

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

(void)	- onSubSessionUsersUpdate:
	Callback event that the users of a SubSession has updated.

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

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

(void)	- onSubSessionUserHelpRequestResult:
	Callback event that the result of help request.

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

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

(void)	- onInAppScreenShareAvailableChanged:
	Called when the availablity 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:
	Notificates of the response of broadcast streaming.

(void)	- onStopBroadcastResponse:
	Notificates of the response of broadcast streaming.

(void)	- onGetBroadcastControlStatus:status:
	Notificates of the response that gets broadcast status.

(void)	- onStreamingJoinStatusChanged:
	Notificates when the viewer's joins status changes.

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

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

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 for the annotation helper clean up. After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.

Parameters

helper The helper clean up object.

◆ onAnnotationPrivilegeChange:shareOwner:

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

optionalrequired

Callback for the annotation privilege change.

Parameters

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

Deprecated: use -[ZoomVideoSDKDelegate onAnnotationPrivilegeChangeWithUser:shareAction:] instead.

◆ onAnnotationPrivilegeChangeWithUser:shareAction:

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

optionalrequired

Callback for the annotation privilege change.

Parameters

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

◆ onAudioLevelChanged:audioSharing:user:

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

optionalrequired

Called when the audio level change 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; otherwise 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 of binds the incoming live stream.

Parameters

helper	Incoming live stream helper utility.
success	YES is success, otherwise NO.
streamKeyID	Corresponding stream key ID.

◆ onBroadcastMessageFromMainSession:userName:

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

optionalrequired

Callback event that 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: Invoked when the invite by phone user joined session success.

Parameters

user	success joined user, See [ZoomVideoSDKUser].
phoneNumber	phone number of callout.

◆ onCameraControlRequestResult:approved:

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

optionalrequired

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

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

Parameters

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

◆ onChatMsgDeleteNotification:messageID:deleteBy:

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

optionalrequired

Callback: Invoked when a user deletes a chat message.

Parameters

helper	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: Invoked when receiving a chat message.

Parameters

helper	Chat helper utility.
chatMessage	the object which contains the message content. See [ZoomVideoSDKChatMessage].

◆ onChatPrivilegeChanged:privilege:

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

optionalrequired

The chat privilege of participant has changed.

Parameters

helper	Chat helper utility.
currentPrivilege	The new chat privilege. See [ZoomVideoSDKChatPrivilegeType].

◆ onCloudRecordingStatus:recordAgreementHandler:

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

optionalrequired

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

Parameters

status	Cloud recording status defined in [ZoomVideoSDKRecordingStatus].
handler	could handle the action user Accept or Decline;.

◆ onCmdChannelConnectResult:

- (void) onCmdChannelConnectResult: (BOOL) success

optionalrequired

Callback: Invoked 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,command channel is ready to be used. NO, Failure, command channel was unable to connect.

◆ onCommandReceived:sendUser:

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

optionalrequired

Callback: Invoked 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	Received command.
sendUser	The user who sent the command.

◆ onError:detail:

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

optionalrequired

Callback: Invoked when errors occur.

Parameters

ErrorType	Provides error code associated with the error. See [ZoomVideoSDKError] for more information.
details	The detail of error message.

◆ onFailedToStartShare:user:

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

optionalrequired

Invoked when a user failed to start sharing.

Parameters

helper	The pointer to a share helper object.
user	The pointer to a user object.

◆ onGetBroadcastControlStatus:status:

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

optionalrequired

Notificates of the response that gets broadcast status.

Parameters

isSuccess	YES if the request succeeded, otherwise false.
status	The current broadcast status, See ZoomVideoSDKBroadcastControlStatus.

◆ onHostAskUnmute

- (void) onHostAskUnmute

optionalrequired

Callback: Invoked when a host requests you to unmute yourself.

◆ onInAppScreenShareAvailableChanged:

- (void) onInAppScreenShareAvailableChanged: (BOOL) available

optionalrequired

Called when the availablity 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 Available or not RPScreenRecorder.

◆ onInAppScreenShareErrorCode:

- (void) onInAppScreenShareErrorCode: (RPRecordingErrorCode) code

optionalrequired

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

Parameters

code	Error code in `RPRecordingErrorCode`.

◆ onIncomingLiveStreamStatusResponse:success:streamsStatusList:

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

optionalrequired

Callback event of gets the streams status.

Parameters

helper	Incoming live stream helper utility.
success	YES is success, otherwise NO.
streamsStatusList	The streams status list.

◆ onInviteByPhoneStatus:failReason:

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

optionalrequired

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

Parameters

status	Invite by phone status. See [ZoomVideoSDKPhoneStatus].
failReason	Invite by phone failed reason. See [ZoomVideoSDKPhoneFailedReason].

◆ onLiveStreamStatusChanged:status:

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

optionalrequired

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

Parameters

helper	Live stream helper utility.
status	Live stream status in enumeration. See [ZoomVideoSDKLiveStreamStatus].

◆ onLiveTranscriptionMsgError:transLanguage:

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

optionalrequired

Callback: Invoked 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: when a live transcription message is received.

Parameters

messageInfo The live transcription message.

◆ onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus: (ZoomVideoSDKLiveTranscriptionStatus) status

optionalrequired

Callback: Invoked when live transcription status changes.

Parameters

status The live transcription status. See [ZoomVideoSDKLiveTranscriptionStatus].

◆ onMicSpeakerVolumeChanged:speakerVolume:

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

optionalrequired

Callback: Notify the current mic or speaker volume when testing.

Parameters

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

◆ onMixedAudioRawDataReceived:

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

optionalrequired

Callback: Invoked when mixed (all users) audio raw data received.

Parameters

rawData Audio raw data. see [ZoomVideoSDKAudioRawData].

◆ onMultiCameraStreamStatusChanged:parentUser:videoCanvas:

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

optionalrequired

Callback: Invoked when someone enables/disables multi-camera. This callback is received by all participants.

Parameters

status	Status for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus].
user	The user who enabled multi-camera. See [ZoomVideoSDKUser].
videoCanvas	the video canvas for the multi-camera. See [ZoomVideoSDKVideoCanvas].

◆ onMultiCameraStreamStatusChanged:parentUser:videoPipe:

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

optionalrequired

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

Parameters

status	Status for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus].
user	The user who enabled multi-camera. See [ZoomVideoSDKUser].
videoPipe	the data pipe for the multi-camera. See [ZoomVideoSDKRawDataPipe].

◆ onMyAudioSourceTypeChanged:

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

optionalrequired

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

Parameters

device The updated audio device. SeeZoomVideoSDKAudioDevice.

◆ onOneWayAudioRawDataReceived:user:

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

optionalrequired

Callback: Invoked when individual user's audio raw data received.

Parameters

rawData	Raw audio data. see [ZoomVideoSDKAudioRawData].
user	See [ZoomVideoSDKUser].

◆ onOriginalLanguageMsgReceived:

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

optionalrequired

Callback: Original language message received callback.

Parameters

messageInfo messageInfo The spoken language message.

◆ onProxySettingNotification:

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

optionalrequired

The callback will be triggered if 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.

◆ onReceiveFileStatus:status:

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

optionalrequired

Invoked when send file status make change.

Parameters

file	The class to receive file object.
status	The stauts of file transfer.

◆ onSendFileStatus:status:

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

optionalrequired

Invoked when send file status make change.

Parameters

file	The class to sendfile object.
status	The stauts of file transfer.

◆ onSessionJoin

- (void) onSessionJoin

optional

Callback: Invoked when the current user joins the session.

◆ onSessionLeave

- (void) onSessionLeave

optionalrequired

Callback: Invoked when the current user leaves the session.

Deprecated: Use onSessionLeave: instead.

◆ onSessionLeave:

- (void) onSessionLeave: (ZoomVideoSDKSessionLeaveReason) reason

optionalrequired

Invoked when the current user leaves the session with reason.

Parameters

reason Leave session reason. See [ZoomVideoSDKSessionLeaveReason] for more information.

◆ onSessionNeedPassword:

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

optionalrequired

Callback: Invoked 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: Invoked 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

Called 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: Invoked 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	share helper util.
user	current start or stop share userInfo.
shareAction	The pointer to a share object.

◆ onShareContentSizeChanged:user:shareAction:

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

optionalrequired

Invoked when the share content size has changed.

Parameters

helper	The pointer to a share helper object.
user	The pointer to a user object who's share content size has changed.
shareAction	The pointer to 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: Invoked when receiving shared raw audio data.

Parameters

rawData rawData Raw audio data. See [ZoomVideoSDKAudioRawData].

◆ onShareSettingChanged:

- (void) onShareSettingChanged: (ZoomVideoSDKShareSetting) setting

optionalrequired

Notification of share setting changed.

Parameters

setting The share setting.

◆ onSpokenLanguageChanged:

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

optionalrequired

Callback 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 of spotlighted video user changes.

Parameters

videoHelper	The pointer of video helper object.
userList	List of users who has been spotlighted.

◆ onSSLCertVerifiedFailNotification:

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

optionalrequired

The callback will be triggered 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

Notificates of the response of broadcast streaming.

Parameters

isSuccess	YES if broadcast streaming started successfully, otherwise false.
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 of starts the binded stream.

Parameters

helper	Incoming live stream helper utility.
success	YES is success, otherwise NO.
streamKeyID	Corresponding stream key ID.

◆ onStopBroadcastResponse:

- (void) onStopBroadcastResponse: (BOOL) isSuccess

optionalrequired

Notificates of the response of broadcast streaming.

Parameters

isSuccess YES if broadcast stopped successfully, otherwise false.

◆ onStopIncomingLiveStreamResponse:success:streamKeyID:

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

optionalrequired

Callback event of stops the binded stream.

Parameters

helper	Incoming live stream helper utility.
success	YES is success, otherwise NO.
streamKeyID	Corresponding stream key ID.

◆ onStreamingJoinStatusChanged:

- (void) onStreamingJoinStatusChanged: (ZoomVideoSDKStreamingJoinStatus) status

optionalrequired

Notificates when the viewer's joins status changes.

Parameters

status The current join status, See ZoomVideoSDKStreamingJoinStatus.

◆ onSubSessionManagerHandle:

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

optionalrequired

Callback event that the user has SubSession manager privilege.

Parameters

pManager The SubSession manager object.

◆ onSubSessionParticipantHandle:

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

optionalrequired

Callback event that 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 that the SubSession status changed.

Parameters

status	The SubSession status.
pSubSessionKitList	The new SubSession list.

◆ onSubSessionUserHelpRequestHandler:

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

optionalrequired

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

Parameters

pHandler The request handler object.

◆ onSubSessionUserHelpRequestResult:

- (void) onSubSessionUserHelpRequestResult: (ZoomVideoSDKUserHelpRequestResult) result

optionalrequired

Callback event that the result of help request.

Parameters

result The result of help reques.

◆ onSubSessionUsersUpdate:

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

optionalrequired

Callback event that the users of a SubSession has updated.

Parameters

pSubSessionKit The SubSession kit object.

◆ onSystemPermissionRequired:

- (void) onSystemPermissionRequired: (ZoomVideoSDKSystemPermissionType) permissionType

optionalrequired

Callback: Invoked when the SDK requires system permissions to continue functioning.

Parameters

permissionType The type of system permission that is required. See [ZoomVideoSDKSystemPermissionType].

◆ onTestMicStatusChanged:

- (void) onTestMicStatusChanged: (ZoomVideoSDKTestMicStatus) status

optionalrequired

Callback: Notify the mic status when testing.

Parameters

status The mic status. For more details, See [ZoomVideoSDKTestMicStatus].

◆ onUnbindIncomingLiveStreamResponse:success:streamKeyID:

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

optionalrequired

Callback event of unbinds the incoming live stream.

Parameters

helper	Incoming live stream helper utility.
success	YES is success, otherwise NO.
streamKeyID	Corresponding stream key ID.

◆ onUserActiveAudioChanged:users:

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

optionalrequired

Callback: Invoked when the active audio changes.

Parameters

helper	Audio helper utility.
userArray	Active audio list.

◆ onUserAudioStatusChanged:user:

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

optionalrequired

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

Parameters

helper	Audio helper utility.
userArray	List of users who have just left the session.

◆ onUserHostChanged:users:

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

optionalrequired

Callback: Invoked when the session host changes.

Parameters

helper	User helper utility.
user	The host userInfo.

◆ onUserJoin:users:

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

optionalrequired

Callback: Invoked when a user joins the session.

Parameters

helper	User help utility.
userArray	List of users who have just joined the session.

◆ onUserLeave:users:

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

optionalrequired

Callback: Invoked when a user leaves the session.

Parameters

helper	User helper utility.
userArray	List of users who have just left the session.

◆ onUserManagerChanged:

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

optionalrequired

Callback: Invoked when the manager of the session changes.

Parameters

user	See [ZoomVideoSDKUser].

◆ onUserNameChanged:

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

optionalrequired

Callback: Invoked when a user changes their name.

Parameters

user	See [ZoomVideoSDKUser].

◆ onUserNetworkStatusChanged:level:user:

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

optionalrequired

Called when the user's share 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: user agreement status change.

Parameters

user	the user which agree the record.

◆ onUserShareNetworkStatusChanged:isSending:

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

optionalrequired

Notification of the current user's share network quality changes.

Parameters

shareNetworkStatus	share network quality.
isSendingShare	Indicates the direction of the share. If YES, it refers to the sending share; if NO, 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

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

Parameters

helper	The pointer to a share helper object.
user	The pointer to a user object.
shareAction	The pointer to the ZoomVideoSDKShareAction object.

◆ onUserVideoNetworkStatusChanged:user:

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

optionalrequired

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

Parameters

status	The user's network status.
user	The pointer to the user who speaks the message.

Deprecated: use onUserNetworkStatusChanged:level:user: instead.

◆ onUserVideoStatusChanged:user:

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

optionalrequired

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

Parameters

helper	Video helper utility.
userArray	List of users who have just left the session.

◆ onUserWhiteboardShareStatusChanged:whiteboardhelper:

- (void) onUserWhiteboardShareStatusChanged:		(ZoomVideoSDKUser *_Nonnull)	user
whiteboardhelper:		(visionos)	API_UNAVAILABLE

optionalrequired

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

Parameters

user	The user who's whiteboard sharing status changed. Check the current status via ZoomVideoSDKUser.
whiteboardHelper	The whiteboard helper object.

◆ onUVCCameraStatusChange:

- (void) onUVCCameraStatusChange: (ZoomVideoSDKUVCCameraStatus) status

optionalrequired

Callback is invoked when the external UVC camera status changes.

Parameters

status 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 of video alpha channel mode changes.

Parameters

isAlphaChannelOn True means that alpha channel mode is on, otherwise off.

◆ 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:		(visionos)	API_UNAVAILABLE

optionalrequired

Callback invoked when a whiteboard file export completes.

Parameters

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

Instance Methods

Detailed Description

Method Documentation

◆ onAnnotationHelperCleanUp:

◆ onAnnotationPrivilegeChange:shareOwner:

◆ onAnnotationPrivilegeChangeWithUser:shareAction:

◆ onAudioLevelChanged:audioSharing:user:

◆ onBindIncomingLiveStreamResponse:success:streamKeyID:

◆ onBroadcastMessageFromMainSession:userName:

◆ onCallCRCDeviceStatusChanged:

◆ onCalloutJoinSuccess:phoneNumber:

◆ onCameraControlRequestResult:approved:

◆ 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:

◆ 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:

◆ onUserNameChanged:

◆ onUserNetworkStatusChanged:level:user:

◆ onUserOverallNetworkStatusChanged:user:

◆ onUserRecordAgreementNotification:

◆ onUserShareNetworkStatusChanged:isSending: