Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
<ZoomVideoSDKDelegate> Protocol Reference

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) - 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) - 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) - onProxySettingNotification:
 The callback will be triggered if the proxy requests to input the username and password.Use the handler to configure the related information. For more details, see ZoomVideoSDKProxySettingHandler.
 
(void) - onSSLCertVerifiedFailNotification:
 The callback will be triggered when the SSL is verified.Use the handler to check the related information. For more details, see ZoomVideoSDKSSLCertVerificationHandler.
 
(void) - onUserVideoNetworkStatusChanged:user:
 Callback event of the user's video network quality 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) - 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.
 

Detailed Description

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

Definition at line 35 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
helperThe helper clean up object.

◆ onAnnotationPrivilegeChange:shareOwner:

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

Callback for the annotation privilege change.

Parameters
enableYES means the user is able to annotate, NO means the user is not able to annotate.
userThe user who changed viewer's annotation privilege

◆ onAnnotationPrivilegeChangeWithUser:shareAction:

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

Callback for the annotation privilege change.

Parameters
userThe pointer to a user object who changed viewer's annotation privilege. For more details, refer to ZoomVideoSDKUser.
shareActionThe pointer to a share object. For more details, refer to ZoomVideoSDKShareAction.

◆ 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
helperIncoming live stream helper utility.
successYES is success, otherwise NO.
streamKeyIDCorresponding stream key ID.

◆ onCallCRCDeviceStatusChanged:

- (void) onCallCRCDeviceStatusChanged: (ZoomVideoSDKCRCCallStatus) state
optionalrequired

Callback event of the call CRC device's status.

Parameters
stateThe 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
usersuccess joined user, See [ZoomVideoSDKUser].
phoneNumberphone 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
userThe pointer to the user who received the request.
isApprovedThe 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
helperChat helper utility.
msgIDThe deleted message's ID.
typeIndicates 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
helperChat helper utility.
chatMessagethe 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
helperChat helper utility.
currentPrivilegeThe 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
statusCloud recording status defined in [ZoomVideoSDKRecordingStatus].
handlercould 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
successYES,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
commandContentReceived command.
sendUserThe user who sent the command.

◆ onError:detail:

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

Callback: Invoked when errors occur.

Parameters
ErrorTypeProvides error code associated with the error. See [ZoomVideoSDKError] for more information.
detailsThe 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
helperThe pointer to a share helper object,
userThe pointer to a user object.

◆ onHostAskUnmute

- (void) onHostAskUnmute
optionalrequired

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

◆ 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
helperIncoming live stream helper utility.
successYES is success, otherwise NO.
streamsStatusListThe 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
statusInvite by phone status. See [ZoomVideoSDKPhoneStatus].
failReasonInvite 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
helperLive stream helper utility.
statusLive 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
spokenLanguageThe spoken message language.
transcriptLanguageThe message language you want to translate.

◆ onLiveTranscriptionMsgReceived:

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

Callback: when a live transcription message is received.

Parameters
messageInfoThe live transcription message

◆ onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus: (ZoomVideoSDKLiveTranscriptionStatus) status
optionalrequired

Callback: Invoked when live transcription status changes.

Parameters
statusThe 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
micVolumeSpecify the volume of the mic when testing or in session.
speakerVolumeSpecify 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
rawDataAudio 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
statusStatus for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus].
userThe user who enabled multi-camera. See [ZoomVideoSDKUser].
videoCanvasthe 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
statusStatus for multipul camera user join or left. See [ZoomVideoSDKMultiCameraStreamStatus].
userThe user who enabled multi-camera. See [ZoomVideoSDKUser].
videoPipethe data pipe for the multi-camera. See [ZoomVideoSDKRawDataPipe].

◆ onOneWayAudioRawDataReceived:user:

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

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

Parameters
rawDataRaw audio data. see [ZoomVideoSDKAudioRawData].
userSee [ZoomVideoSDKUser].

◆ onOriginalLanguageMsgReceived:

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

Callback: Original language message received callback.

Parameters
messageInfomessageInfo The spoken language message, refer to ZoomVideoSDKLiveTranscriptionMessageInfo.

◆ 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. For more details, see ZoomVideoSDKProxySettingHandler.

Parameters
handlerThe 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
fileThe class to receive file object.
statusThe stauts of file transfer.

◆ onSendFileStatus:status:

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

Invoked when send file status make change.

Parameters
fileThe class to sendfile object.
statusThe 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.

◆ onSessionLeave:

- (void) onSessionLeave: (ZoomVideoSDKSessionLeaveReason) reason
optionalrequired

Invoked when the current user leaves the session with reason.

Parameters
reasonLeave 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
completionthe 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
completionthe 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
failReasonThe fail reason. For more details, see ZoomVideoSDKSubscribeFailReason.
userThe pointer to the user whose view we would like to subscribe. For more details, refer to ZoomVideoSDKUser.
viewThe view that failed to subscribe.

◆ 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
userThe pointer to the user object whose view we would like to subscribe to. For more details, refer to ZoomVideoSDKUser.
viewThe view that failed to subscribe.
shareActionThe pointer to a share object. For more details, refer to ZoomVideoSDKShareAction.

◆ 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
shareHelpershare helper util
userInfocurrent start or stop share userInfo.
shareActionZoomVideoSDKShareAction

◆ 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
helperThe pointer to a share helper object, see ZoomVideoSDKShareHelper.
userThe pointer to a user object who's share content size has changed, see ZoomVideoSDKUser.
shareActionThe pointer to the ZoomVideoSDKShareAction object. For more details, refer to ZoomVideoSDKShareAction.

◆ onSharedAudioRawDataReceived:

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

Callback: Invoked when receiving shared raw audio data.

Parameters
rawDatarawData Raw audio data. See [ZoomVideoSDKAudioRawData].

◆ onSpotlightVideoChanged:userList:

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

Callback event of spotlighted video user changes.

Parameters
videoHelperThe pointer of video helper object.
userListList 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. For more details, see ZoomVideoSDKSSLCertVerificationHandler.

Parameters
handlerThe handler will be destroyed once the function calls end.

◆ onStartIncomingLiveStreamResponse:success:streamKeyID:

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

Callback event of starts the binded stream.

Parameters
helperIncoming live stream helper utility.
successYES is success, otherwise NO.
streamKeyIDCorresponding stream key ID.

◆ onStopIncomingLiveStreamResponse:success:streamKeyID:

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

Callback event of stops the binded stream.

Parameters
helperIncoming live stream helper utility.
successYES is success, otherwise NO.
streamKeyIDCorresponding stream key ID.

◆ onSystemPermissionRequired:

- (void) onSystemPermissionRequired: (ZoomVideoSDKSystemPermissionType) permissionType
optionalrequired

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

Parameters
permissionTypeThe type of system permission that is required. See [ZoomVideoSDKSystemPermissionType].

◆ onTestMicStatusChanged:

- (void) onTestMicStatusChanged: (ZoomVideoSDKTestMicStatus) status
optionalrequired

Callback: Notify the mic status when testing.

Parameters
statusThe 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
helperIncoming live stream helper utility.
successYES is success, otherwise NO.
streamKeyIDCorresponding stream key ID.

◆ onUserActiveAudioChanged:users:

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

Callback: Invoked when the active audio changes.

Parameters
helperAudio helper utility.
userArrayActive 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
helperAudio helper utility.
userArrayList 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
helperUser helper utility.
userThe host userInfo.

◆ onUserJoin:users:

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

Callback: Invoked when a user joins the session.

Parameters
helperUser help utility.
userArrayList 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
helperUser helper utility.
userArrayList 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
userSee [ZoomVideoSDKUser].

◆ onUserNameChanged:

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

Callback: Invoked when a user changes their name.

Parameters
userSee [ZoomVideoSDKUser].

◆ onUserRecordAgreementNotification:

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

Callback: user agreement status change.

Parameters
userthe user which agree the record.

◆ 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
helperThe pointer to a share helper object, see ZoomVideoSDKShareHelper.
userThe pointer to a user object.
shareActionhe pointer to the ZoomVideoSDKShareAction object. For more details, refer to ZoomVideoSDKShareAction.

◆ onUserVideoNetworkStatusChanged:user:

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

Callback event of the user's video network quality changes.

Parameters
statusstatus video network quality. For more details, See ZoomVideoSDKNetworkStatus.
userThe pointer to the user who speaks the message. For more details, refer to ZoomVideoSDKUser.

◆ 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
helperVideo helper utility.
userArrayList of users who have just left the session.

◆ onUVCCameraStatusChange:

- (void) onUVCCameraStatusChange: (ZoomVideoSDKUVCCameraStatus) status
optionalrequired

Callback is invoked when the external UVC camera status changes.

Parameters
statusUVC 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
isAlphaChannelOnTrue 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
failReasonThe fail reason. For more details, see ZoomVideoSDKSubscribeFailReason.
userThe pointer to the user whose view we would like to subscribe. For more details, refer to ZoomVideoSDKUser.
viewThe view that failed to subscribe.