Delegate protocol to receive session related callbacks. More...

#include <ZMVideoSDKDelegate.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:userList:
	Callback: Invoked when a user joins the session.

(void)	- onUserLeave:userList:
	Triggered when other users leave session.

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

(void)	- onUserAudioStatusChanged:userList:
	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)	- onShareContentSizeChanged:user:shareAction:
	Invoked when the share content size has changed.

(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 ZMVideoSDKShareType.

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

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

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

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

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

(void)	- onUserActiveAudioChanged:userList:
	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)	- onUserManagerChanged:
	Callback: Invoked when the manager of the session changes.

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

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

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

(void)	- onUserRecordingConsent:
	Invoked when a user consents to individual recording.

(void)	- onCommandReceived:senderUser:
	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)	- onCameraControlRequestReceived:cameraControlRequestType:requestHandler:
	Callback interface for when the current user has received a camera control request.

(void)	- onCommandChannelConnectResult:
	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)	- onHostAskUnmute
	Callback: Invoked when a host requests you to unmute yourself.

(void)	- onInviteByPhoneStatus:reason:
	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)	- onMultiCameraStreamStatusChanged:user:rawDataPipe:
	Callback: Invoked when someone in a given session enables or disables multi-camera. All participants in the session receive this callback.

(void)	- onAudioLevelChanged:audioSharing:user:
	Notification of the audio level changes for a participant (excluding self).

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

(void)	- onAudioDeviceStatusChanged:status:
	Notify that either mic device or speaker device status changed.

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

(void)	- onSelectedAudioDeviceChanged
	Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/speaker testing. The user shall restart the test manually if he still wants to test.

(void)	- onCameraListChanged
	Notify that the camera list has updated.

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

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

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

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

(void)	- onSpokenLanguageChanged:
	Notification of the spoken language has changed.

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

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

(void)	- onProxyDetectComplete
	Notification callback of completing the proxy detection.

(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:
	Callback event of the user's video network quality changes.

(void)	- onShareNetworkStatusChanged:isSendingShare:
	Callback event of the current user's share network quality changes.

(void)	- onUserNetworkStatusChanged:level:user:
	Called when a user's network status changes for a specific data type.

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

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

(void)	- onVideoCanvasSubscribeFail:user:view:
	Callback event for the vidoe canvas that failed to subscribe.

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

(void)	- onAnnotationHelperCleanUp:
	Callback for the annotation helper clean up. SDK will release the ZoomVideoSDKAnnotationHelper object as well.

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

(void)	- onAnnotationHelperActived:
	Callback for the annotation helper activated. Notify that annotation windows have been created.

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

(void)	- onReceiveFile:status:
	Invoked when receive file status make change.

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

(void)	- onRemoteControlStatus:user:shareAction:
	Callback for when the remote control status changes.

(void)	- onRemoteControlRequestReceived:shareAction:handler:
	Callback for when the current user has received a remote control request. This will be triggered when another user requests control of the current user's screen.

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

(void)	- onBindIncomingLiveStreamResponse:streamKeyID:
	Callback event that binds incoming live stream.

(void)	- onUnbindIncomingLiveStreamResponse:streamKeyID:
	Callback event that unbinds incoming live stream.

(void)	- onIncomingLiveStreamStatusResponse:streamsStatusList:
	Callback event that gets streams status.

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

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

(void)	- onSubSessionStatusChanged:subSessionKit:
	Callback event for when the subsession status changes.

(void)	- onSubSessionManagerHandle:
	Callback event when a user gains or loses subsession manager privileges.

(void)	- onSubSessionParticipantHandle:
	Callback event when a user gains or loses subsession participant privileges.

(void)	- onSubSessionUsersUpdate:
	Callback event when the subsession users are updated.

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

(void)	- onSubSessionUserHelpRequest:
	Callback event when the user receives a help request from a subsession.

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

(void)	- onWhiteboardExported:data:dataLength:
	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.

(void)	- onStartBroadcastResponse:channelID:
	Notificates the response of starting broadcast streaming.

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

(void)	- onGetBroadcastControlStatus:broadcastControlStatus:
	Notificates the response of getting broadcast status.

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

(void)	- onRealTimeMediaStreamsStatusChanged:
	Callback: Invoked when the real-time media streams status changes.

(void)	- onRealTimeMediaStreamsFail:
	Callback: Invoked when real-time media streams fails.

Detailed Description

Delegate protocol to receive session related callbacks.

Definition at line 45 of file ZMVideoSDKDelegate.h.

Method Documentation

◆ onAnnotationHelperActived:

- (void) onAnnotationHelperActived: (NSView *_Nullable) view

optionalrequired

Callback for the annotation helper activated. Notify that annotation windows have been created.

Parameters

view	The view that annotating.

◆ onAnnotationHelperCleanUp:

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

optionalrequired

Callback for the annotation helper clean up. SDK will release the ZoomVideoSDKAnnotationHelper object as well.

Parameters

helper The helper clean up object.

◆ onAnnotationPrivilegeChange:shareAction:

- (void) onAnnotationPrivilegeChange:		(ZMVideoSDKUser *_Nullable)	user
shareAction:		(ZMVideoSDKShareAction *_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 ZMVideoSDKShareAction object.

◆ onAudioDeviceStatusChanged:status:

- (void) onAudioDeviceStatusChanged:		(ZMVideoSDKAudioDeviceType)	type
status:		(ZMVideoSDKAudioDeviceStatus)	status

optionalrequired

Notify that either mic device or speaker device status changed.

Parameters

type	The audio device type.
status	The audio device status.

◆ onAudioLevelChanged:audioSharing:user:

- (void) onAudioLevelChanged:	(unsigned int)	level
audioSharing:	(BOOL)	bAudioSharing
user:	(ZMVideoSDKUser *_Nullable)	user

optionalrequired

Notification of the audio level changes for a participant (excluding self).

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.
pUser	The user whose audio level has changed.

◆ onBindIncomingLiveStreamResponse:streamKeyID:

- (void) onBindIncomingLiveStreamResponse:		(BOOL)	bSuccess
streamKeyID:		(NSString *)	streamKeyID

optionalrequired

Callback event that binds incoming live stream.

Parameters

bSuccess	YES is success, otherwise false.
streamKeyID	Corresponding stream key id.

◆ onBroadcastMessageFromMainSession:userName:

- (void) onBroadcastMessageFromMainSession:		(NSString *)	message
userName:		(NSString *)	name

optionalrequired

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

Parameters

message	The message content.
name	The name of the user who broadcasted this message.

◆ onCallCRCDeviceStatusChanged:

- (void) onCallCRCDeviceStatusChanged: (ZMVideoSDKCRCCallStatus) status

optionalrequired

Callback event of the call CRC device's status.

Parameters

status The call status.

◆ onCalloutJoinSuccess:phoneNumber:

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

optionalrequired

Callback: Invoked when the invite by phone user joined session success.

Parameters

user	success joined user.
phoneNumber	Phone number of callout.

◆ onCameraControlRequestReceived:cameraControlRequestType:requestHandler:

- (void) onCameraControlRequestReceived:	(ZMVideoSDKUser *_Nullable)	user
cameraControlRequestType:	(ZMVideoSDKCameraControlRequestType)	requestType
requestHandler:	(ZMVideoSDKCameraControlRequestHandler *_Nullable)	cameraControlRequestHandler

optionalrequired

Callback interface for when the current user has received a camera control request.

Parameters

user	The pointer to the user who sent the request.
requestType	The request type.
cameraControlRequestHandler	The pointer to the helper instance of the camera controller.

Note: This will be triggered when another user requests control of the current users camera.

◆ onCameraControlRequestResult:approved:

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

optionalrequired

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

Parameters

user	The pointer to 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.

◆ onCameraListChanged

- (void) onCameraListChanged

optionalrequired

Notify that the camera list has updated.

◆ onChatMsgDeleteNotification:messageID:deleteBy:

- (void) onChatMsgDeleteNotification:	(ZMVideoSDKChatHelper *_Nonnull)	chatHelper
messageID:	(NSString *_Nullable)	msgID
deleteBy:	(ZMVideoSDKChatMessageDeleteType)	type

optionalrequired

Callback: Invoked when a user deletes a chat message.

Parameters

chatHelper	The pointer to chat helper object.
msgID	The deleted message's ID.
type	Indicates by whom the message was deleted.

◆ onChatNewMessageNotify:chatMessage:

- (void) onChatNewMessageNotify:		(ZMVideoSDKChatHelper *_Nonnull)	chatHelper
chatMessage:		(ZMVideoSDKChatMessage *_Nullable)	chatMessage

optionalrequired

Callback: Invoked when receiving a chat message.

Parameters

chatHelper	The pointer of chat helper object.
chatMessage	The pointer of chat message object.

◆ onChatPrivilegeChanged:chatPrivilegeType:

- (void) onChatPrivilegeChanged:		(ZMVideoSDKChatHelper *_Nonnull)	chatHelper
chatPrivilegeType:		(ZMVideoSDKChatPrivilegeType)	privilege

optionalrequired

Callback event of the chat privilege of participant has changed.

Parameters

chatHelper	The pointer to chat helper object.
privilege	The new chat privilege.

◆ onCloudRecordingStatus:recordingConsentHandler:

- (void) onCloudRecordingStatus:		(ZMRecordingStatus)	status
recordingConsentHandler:		(ZMVideoSDKRecordingConsentHandler *_Nullable)	handler

optionalrequired

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

Parameters

status	Cloud recording status.
handler	When the cloud recording starts, this object is used to let the user choose whether to accept or not.

◆ onCommandChannelConnectResult:

- (void) onCommandChannelConnectResult: (BOOL) isSuccess

optionalrequired

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

isSuccess YES: Success, command channel is ready to be used. NO: Failure, command channel was unable to connect.

◆ onCommandReceived:senderUser:

- (void) onCommandReceived:		(NSString *_Nullable)	commandContent
senderUser:		(ZMVideoSDKUser *_Nullable)	user

optionalrequired

Once the command channel is active, this callback is triggered each time a message is received.

Parameters

commandContent	Received command.
user	The user who sent the command.

◆ onError:detail:

- (void) onError:		(ZMVideoSDKErrors)	ErrorType
detail:		(int)	details

optionalrequired

Callback: Invoked when errors occur.

Parameters

ErrorType	Provides error code associated with the error.
details	Detailed errorCode.

◆ onFailedToStartShare:user:

- (void) onFailedToStartShare:		(ZMVideoSDKShareHelper *_Nonnull)	shareHelper
user:		(ZMVideoSDKUser *_Nullable)	user

optionalrequired

Invoked when a user failed to start sharing.

Parameters

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

◆ onGetBroadcastControlStatus:broadcastControlStatus:

- (void) onGetBroadcastControlStatus:		(BOOL)	isSuccess
broadcastControlStatus:		(ZMVideoSDKBroadcastControlStatus)	status

optionalrequired

Notificates the response of getting broadcast status.

Parameters

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

◆ onHostAskUnmute

- (void) onHostAskUnmute

optionalrequired

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

◆ onIncomingLiveStreamStatusResponse:streamsStatusList:

- (void) onIncomingLiveStreamStatusResponse:		(BOOL)	bSuccess
streamsStatusList:		(NSArray *)	streamsStatusList

optionalrequired

Callback event that gets streams status.

Parameters

bSuccess	YES is success, otherwise false.
streamsStatusList	The streams status list.

◆ onInviteByPhoneStatus:reason:

- (void) onInviteByPhoneStatus:		(ZMPhoneStatus)	status
reason:		(ZMPhoneFailedReason)	reason

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.
reason	Invite by phone failed reason.

◆ onLiveStreamStatusChanged:liveStreamStatus:

- (void) onLiveStreamStatusChanged:		(ZMVideoSDKLiveStreamHelper *_Nonnull)	liveStreamHelper
liveStreamStatus:		(ZMVideoSDKLiveStreamStatus)	status

optionalrequired

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

Parameters

liveStreamHelper	The pointer of live stream helper object.
status	The current status of live stream.

◆ onLiveTranscriptionMsgError:transcriptLanguage:

- (void) onLiveTranscriptionMsgError:		(ZMVideoSDKLiveTranscriptionLanguage *_Nullable)	spokenLanguage
transcriptLanguage:		(ZMVideoSDKLiveTranscriptionLanguage *_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.

◆ onLiveTranscriptionMsgInfoReceived:

- (void) onLiveTranscriptionMsgInfoReceived: (ZMVideoSDKLiveTranscriptionMessageInfo *_Nullable) messageInfo

optionalrequired

Callback: Invoked when a live transcription message is received.

Parameters

messageInfo The live transcription message.

◆ onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus: (ZMVideoSDKLiveTranscriptionStatus) status

optionalrequired

Callback: Invoked when live transcription status changes.

Parameters

status The live transcription status.

◆ onMicSpeakerVolumeChanged:speakerVolume:

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

optionalrequired

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: (ZMVideoSDKAudioRawData *_Nonnull) data

optionalrequired

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

Parameters

data	The pointer of audio raw data.

◆ onMultiCameraStreamStatusChanged:user:rawDataPipe:

- (void) onMultiCameraStreamStatusChanged:	(ZMVideoSDKMultiCameraStreamStatus)	status
user:	(ZMVideoSDKUser *_Nullable)	user
rawDataPipe:	(ZMVideoSDKRawDataPipe *_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	The status of camera.
user	The user who enabled multi-camera.
videoPipe	The data pipe for the multi-camera.

◆ onOneWayAudioRawDataReceived:user:

- (void) onOneWayAudioRawDataReceived:		(ZMVideoSDKAudioRawData *_Nonnull)	data
user:		(ZMVideoSDKUser *_Nullable)	user

optionalrequired

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

Parameters

data	Raw audio data.
user	The user object associated with the raw audio data.

◆ onOriginalLanguageMsgReceived:

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

optionalrequired

Original language message received callback.

Parameters

messageInfo The spoken language message.

◆ onProxyDetectComplete

- (void) onProxyDetectComplete

optionalrequired

Notification callback of completing the proxy detection.

◆ onProxySettingNotification:

- (void) onProxySettingNotification: (ZMVideoSDKProxySettingHandler *_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 A handler used to configure proxy credentials. The handler will be destroyed once the function calls end.

◆ onRealTimeMediaStreamsFail:

- (void) onRealTimeMediaStreamsFail: (ZMVideoSDKRealTimeMediaStreamsFailReason) failReason

optionalrequired

Callback: Invoked when real-time media streams fails.

Parameters

failReason The reason for the failure.

◆ onRealTimeMediaStreamsStatusChanged:

- (void) onRealTimeMediaStreamsStatusChanged: (ZMVideoSDKRealTimeMediaStreamsStatus) status

optionalrequired

Callback: Invoked when the real-time media streams status changes.

Parameters

status The current real-time media streams status.

◆ onReceiveFile:status:

- (void) onReceiveFile:		(ZMVideoSDKReceiveFile *_Nullable)	receiveFile
status:		(ZMVideoSDKFileTransferStatus)	status

optionalrequired

Invoked when receive file status make change.

Parameters

receiveFile	The pointer to receive file object.
status	The status of file transfer.

◆ onRemoteControlRequestReceived:shareAction:handler:

- (void) onRemoteControlRequestReceived:	(ZMVideoSDKUser *)	user
shareAction:	(ZMVideoSDKShareAction *_Nullable)	shareAction
handler:	(ZMVideoSDKRemoteControlRequestHandler *)	handler

optionalrequired

Callback for when the current user has received a remote control request. This will be triggered when another user requests control of the current user's screen.

Parameters

user	The pointer to a user who sent the request.
shareAction	The pointer to a ZMVideoSDKShareAction object.
handler	The pointer to a helper instance of the remote controller.

◆ onRemoteControlStatus:user:shareAction:

- (void) onRemoteControlStatus:	(ZMVideoSDKRemoteControlStatus)	status
user:	(ZMVideoSDKUser *)	user
shareAction:	(ZMVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback for when the remote control status changes.

Parameters

status	The value of the remote control status.
user	The remote control user.
shareAction	The pointer to a ZMVideoSDKShareAction object.

◆ onSelectedAudioDeviceChanged

- (void) onSelectedAudioDeviceChanged

optionalrequired

Notify the user that a mic/speaker device is selected when testing. Then the SDK will close the mic/speaker testing. The user shall restart the test manually if he still wants to test.

◆ onSendFile:status:

- (void) onSendFile:		(ZMVideoSDKSendFile *_Nullable)	sendFile
status:		(ZMVideoSDKFileTransferStatus)	status

optionalrequired

Invoked when send file status make change.

Parameters

sendFile	The pointer to send file object.
status	The status 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 ZMVideoSDKDelegate::onSessionLeave: instead.

◆ onSessionLeave:

- (void) onSessionLeave: (ZMVideoSDKSessionLeaveReason) reason

optionalrequired

Invoked when the current user leaves the session with reason.

Parameters

reason The leave reason.

◆ onSessionNeedPassword:

- (void) onSessionNeedPassword: (ZMVideoSDKPasswordHandler *_Nonnull) handle

optionalrequired

Callback: Invoked when the session requires a password to join.

Parameters

handle The pointer to password handler object.

◆ onSessionPasswordWrong:

- (void) onSessionPasswordWrong: (ZMVideoSDKPasswordHandler *_Nonnull) handle

optionalrequired

Callback: Invoked when the provided session password is wrong or invalid.

Parameters

handle The pointer to password handler object.

◆ onShareCanvasSubscribeFail:view:shareAction:

- (void) onShareCanvasSubscribeFail:	(ZMVideoSDKUser *_Nullable)	user
view:	(NSView *_Nullable)	view
shareAction:	(ZMVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Callback event for the subscribed user's share view failure reason.

Parameters

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

◆ onShareContentChanged:user:shareAction:

- (void) onShareContentChanged:	(ZMVideoSDKShareHelper *_Nonnull)	shareHelper
user:	(ZMVideoSDKUser *)	user
shareAction:	(ZMVideoSDKShareAction *_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 ZMVideoSDKShareType.

Parameters

shareHelper	The pointer to share helper object.
user	current start or stop share userInfo.
shareAction	The pointer to a ZMVideoSDKShareAction object.

◆ onShareContentSizeChanged:user:shareAction:

- (void) onShareContentSizeChanged:	(ZMVideoSDKShareHelper *_Nonnull)	shareHelper
user:	(ZMVideoSDKUser *_Nullable)	user
shareAction:	(ZMVideoSDKShareAction *_Nullable)	shareAction

optionalrequired

Invoked when the share content size has changed.

Parameters

shareHelper	The pointer to a share helper object.
user	The pointer to a user object.
shareAction	The pointer to a ZMVideoSDKShareAction 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: (ZMVideoSDKAudioRawData *_Nullable) data

optionalrequired

Callback: Invoked when receiving shared raw audio data.

Parameters

data	Raw audio data.

◆ onShareNetworkStatusChanged:isSendingShare:

- (void) onShareNetworkStatusChanged:		(ZMVideoSDKNetworkStatus)	status
isSendingShare:		(BOOL)	isSendingShare

optionalrequired

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

Parameters

status	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 ZMVideoSDKDelegate::onUserNetworkStatusChanged:level:user: instead.

◆ onShareSettingChanged:

- (void) onShareSettingChanged: (ZMVideoSDKShareSetting) setting

optionalrequired

Notification of the share setting has changed.

Parameters

setting The share setting, see ZMVideoSDKShareSetting

◆ onSpokenLanguageChanged:

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

optionalrequired

Notification of the spoken language has changed.

Parameters

spokenLanguage The spoken message language.

◆ onSpotlightVideoChanged:userList:

- (void) onSpotlightVideoChanged:		(ZMVideoSDKVideoHelper *)	videoHelper
userList:		(NSArray< ZMVideoSDKUser * > *_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: (ZMVideoSDKSSLCertificateInfo *_Nonnull) info

optionalrequired

The callback will be triggered when the SSL is verified. Use the handler to check the related information.

Parameters

info	A certificate information object for verification failure. The object will be destroyed once the function calls end.

◆ onStartBroadcastResponse:channelID:

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

optionalrequired

Notificates the response of starting broadcast streaming.

Parameters

isSuccess	YES if broadcast streaming started successfully; otherwise NO.
channelID	The broadcast streaming channel ID returned by the backend.

◆ onStartIncomingLiveStreamResponse:streamKeyID:

- (void) onStartIncomingLiveStreamResponse:		(BOOL)	bSuccess
streamKeyID:		(NSString *)	streamKeyID

optionalrequired

Callback event that starts the binded stream.

Parameters

bSuccess	YES is success, otherwise false.
streamKeyID	Corresponding stream key id.

◆ onStopBroadcastResponse:

- (void) onStopBroadcastResponse: (BOOL) isSuccess

optionalrequired

Notificates the response of stopping broadcast streaming.

Parameters

isSuccess YES if broadcast stopped successfully; otherwise NO.

◆ onStopIncomingLiveStreamResponse:streamKeyID:

- (void) onStopIncomingLiveStreamResponse:		(BOOL)	bSuccess
streamKeyID:		(NSString *)	streamKeyID

optionalrequired

Callback event that stops the binded stream.

Parameters

bSuccess	YES is success, otherwise false.
streamKeyID	Corresponding stream key id.

◆ onStreamingJoinStatusChanged:

- (void) onStreamingJoinStatusChanged: (ZMVideoSDKStreamingJoinStatus) status

optionalrequired

Notificates when the viewer's join status changes.

Parameters

status The current join status.

◆ onSubSessionManagerHandle:

- (void) onSubSessionManagerHandle: (ZMVideoSDKSubSessionManager *_Nullable) manager

optionalrequired

Callback event when a user gains or loses subsession manager privileges.

Parameters

manager The subsession manager object, when the user loses manager privileges, manager is nil.

◆ onSubSessionParticipantHandle:

- (void) onSubSessionParticipantHandle: (ZMVideoSDKSubSessionParticipant *_Nullable) participant

optionalrequired

Callback event when a user gains or loses subsession participant privileges.

Parameters

participant The subsession participant object, when the user loses participant privileges, participant is nil.

◆ onSubSessionStatusChanged:subSessionKit:

- (void) onSubSessionStatusChanged:		(ZMVideoSDKSubSessionStatus)	status
subSessionKit:		(NSArray< ZMVideoSDKSubSessionKit * > *_Nullable)	subSessionKitList

optionalrequired

Callback event for when the subsession status changes.

Parameters

status	The subsession status.
subSessionKitList	The subsession which status has changed. It has value only when status is Committed/Withdrawn/WithdrawFailed.

◆ onSubSessionUserHelpRequest:

- (void) onSubSessionUserHelpRequest: (ZMVideoSDKSubSessionUserHelpRequestHandler *) handler

optionalrequired

Callback event when the user receives a help request from a subsession.

Parameters

handler The request handler object.

◆ onSubSessionUserHelpRequestResult:

- (void) onSubSessionUserHelpRequestResult: (ZMVideoSDKUserHelpRequestResult) result

optionalrequired

Callback event when the result of the help request.

Parameters

result The result of help request.

◆ onSubSessionUsersUpdate:

- (void) onSubSessionUsersUpdate: (ZMVideoSDKSubSessionKit *_Nullable) subSessionKit

optionalrequired

Callback event when the subsession users are updated.

Parameters

subSessionKit The subSession kit object.

◆ onTestMicStatusChanged:

- (void) onTestMicStatusChanged: (ZMVideoSDKMicTestStatus) status

optionalrequired

Notify the mic status when testing.

Parameters

status The mic status.

◆ onUnbindIncomingLiveStreamResponse:streamKeyID:

- (void) onUnbindIncomingLiveStreamResponse:		(BOOL)	bSuccess
streamKeyID:		(NSString *)	streamKeyID

optionalrequired

Callback event that unbinds incoming live stream.

Parameters

bSuccess	YES is success, otherwise false.
streamKeyID	Corresponding stream key id.

◆ onUserActiveAudioChanged:userList:

- (void) onUserActiveAudioChanged:		(ZMVideoSDKAudioHelper *_Nonnull)	audioHelper
userList:		(NSArray< ZMVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback: Invoked when the active audio changes.

Parameters

audioHelper	The pointer of audio helper object.
userArray	Active audio list.

◆ onUserAudioStatusChanged:userList:

- (void) onUserAudioStatusChanged:		(ZMVideoSDKAudioHelper *_Nonnull)	audioHelper
userList:		(NSArray< ZMVideoSDKUser * > *_Nullable)	userArray

optionalrequired

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

Parameters

audioHelper	The pointer of audio helper object.
userArray	The array contain user objoct.

◆ onUserHostChanged:user:

- (void) onUserHostChanged:		(ZMVideoSDKUserHelper *_Nonnull)	userHelper
user:		(ZMVideoSDKUser *_Nullable)	user

optionalrequired

Callback: Invoked when the session host changes.

Parameters

userHelper	The pointer of user helper object.
user	The pointer of user object.

◆ onUserJoin:userList:

- (void) onUserJoin:		(ZMVideoSDKUserHelper *_Nonnull)	userHelper
userList:		(NSArray< ZMVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Callback: Invoked when a user joins the session.

Parameters

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

◆ onUserLeave:userList:

- (void) onUserLeave:		(ZMVideoSDKUserHelper *_Nonnull)	userHelper
userList:		(NSArray< ZMVideoSDKUser * > *_Nullable)	userArray

optionalrequired

Triggered when other users leave session.

Parameters

userHelper	The pointer of user helper object.
userArray	An array contains the users leaved.

◆ onUserManagerChanged:

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

optionalrequired

Callback: Invoked when the manager of the session changes.

Parameters

user	The pointer of user object.

◆ onUserNameChanged:

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

optionalrequired

Callback: Invoked when a user changes their name.

Parameters

user	The pointer of user object.

◆ onUserNetworkStatusChanged:level:user:

- (void) onUserNetworkStatusChanged:	(ZMVideoSDKDataType)	type
level:	(ZMVideoSDKNetworkStatus)	level
user:	(ZMVideoSDKUser *)	user

optionalrequired

Called when a user's network status changes for a specific data type.

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:		(ZMVideoSDKNetworkStatus)	level
user:		(ZMVideoSDKUser *)	user

optionalrequired

Called 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.

◆ onUserRecordingConsent:

- (void) onUserRecordingConsent: (ZMVideoSDKUser *_Nullable) user

optionalrequired

Invoked when a user consents to individual recording.

Parameters

user	The pointer to the user object.

◆ onUserShareStatusChanged:user:shareAction:

- (void) onUserShareStatusChanged:	(ZMVideoSDKShareHelper *_Nonnull)	shareHelper
user:	(ZMVideoSDKUser *_Nullable)	user
shareAction:	(ZMVideoSDKShareAction *_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

shareHelper	The pointer to a share helper object.
user	The pointer to a user object.
shareAction	The pointer to a ZMVideoSDKShareAction object.

◆ onUserVideoNetworkStatusChanged:user:

- (void) onUserVideoNetworkStatusChanged:		(ZMVideoSDKNetworkStatus)	status
user:		(ZMVideoSDKUser *_Nullable)	user

optionalrequired

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

Parameters

status	Video network quality.
user	The pointer to a user object.

Deprecated: Use ZMVideoSDKDelegate::onUserNetworkStatusChanged:level:user: instead.

◆ onUserVideoStatusChanged:userList:

- (void) onUserVideoStatusChanged:		(ZMVideoSDKVideoHelper *_Nonnull)	videoHelper
userList:		(NSArray< ZMVideoSDKUser * > *_Nullable)	userArray

optionalrequired

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

Parameters

videoHelper	The pointer of video helper object.
userArray	The array contain user objoct.

◆ onUserWhiteboardShareStatusChanged:whiteboardHelper:

- (void) onUserWhiteboardShareStatusChanged:		(ZMVideoSDKUser *)	user
whiteboardHelper:		(ZMVideoSDKWhiteboardHelper *)	whiteboardHelper

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 ZMVideoSDKWhiteboardStatus.
whiteboardHelper	The whiteboard helper object.

◆ onVideoAlphaChannelStatusChanged:

- (void) onVideoAlphaChannelStatusChanged: (BOOL) isAlphaModeOn

optionalrequired

Callback event of alpha channel mode changes.

Parameters

isAlphaModeOn YES means it's in alpha channel mode. Otherwise, it's not.

◆ onVideoCanvasSubscribeFail:user:view:

- (void) onVideoCanvasSubscribeFail:	(ZMVideoSDKSubscribeFailReason)	failReason
user:	(ZMVideoSDKUser *_Nullable)	user
view:	(NSView *_Nullable)	view

optionalrequired

Callback event for the vidoe canvas that failed to subscribe.

Parameters

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

◆ onWhiteboardExported:data:dataLength:

- (void) onWhiteboardExported:	(ZMVideoSDKExportFormat)	format
data:	(unsigned char *)	data
dataLength:	(long)	length

optionalrequired

Callback invoked when a whiteboard file export completes.

Parameters

format	The export format. See ZMVideoSDKExportFormat.
data	The export whiteboard data as a byte array.
length	The length of the export whiteboard data.

Instance Methods

Detailed Description

Method Documentation

◆ onAnnotationHelperActived:

◆ onAnnotationHelperCleanUp:

◆ onAnnotationPrivilegeChange:shareAction:

◆ onAudioDeviceStatusChanged:status:

◆ onAudioLevelChanged:audioSharing:user:

◆ onBindIncomingLiveStreamResponse:streamKeyID:

◆ onBroadcastMessageFromMainSession:userName:

◆ onCallCRCDeviceStatusChanged:

◆ onCalloutJoinSuccess:phoneNumber:

◆ onCameraControlRequestReceived:cameraControlRequestType:requestHandler:

◆ onCameraControlRequestResult:approved:

◆ onCameraListChanged

◆ onChatMsgDeleteNotification:messageID:deleteBy:

◆ onChatNewMessageNotify:chatMessage:

◆ onChatPrivilegeChanged:chatPrivilegeType:

◆ onCloudRecordingStatus:recordingConsentHandler:

◆ onCommandChannelConnectResult:

◆ onCommandReceived:senderUser:

◆ onError:detail:

◆ onFailedToStartShare:user:

◆ onGetBroadcastControlStatus:broadcastControlStatus:

◆ onHostAskUnmute

◆ onIncomingLiveStreamStatusResponse:streamsStatusList:

◆ onInviteByPhoneStatus:reason:

◆ onLiveStreamStatusChanged:liveStreamStatus:

◆ onLiveTranscriptionMsgError:transcriptLanguage:

◆ onLiveTranscriptionMsgInfoReceived:

◆ onLiveTranscriptionStatus:

◆ onMicSpeakerVolumeChanged:speakerVolume:

◆ onMixedAudioRawDataReceived:

◆ onMultiCameraStreamStatusChanged:user:rawDataPipe:

◆ onOneWayAudioRawDataReceived:user:

◆ onOriginalLanguageMsgReceived:

◆ onProxyDetectComplete

◆ onProxySettingNotification:

◆ onRealTimeMediaStreamsFail:

◆ onRealTimeMediaStreamsStatusChanged:

◆ onReceiveFile:status:

◆ onRemoteControlRequestReceived:shareAction:handler:

◆ onRemoteControlStatus:user:shareAction:

◆ onSelectedAudioDeviceChanged

◆ onSendFile:status:

◆ onSessionJoin

◆ onSessionLeave

◆ onSessionLeave:

◆ onSessionNeedPassword:

◆ onSessionPasswordWrong:

◆ onShareCanvasSubscribeFail:view:shareAction:

◆ onShareContentChanged:user:shareAction:

◆ onShareContentSizeChanged:user:shareAction:

◆ onSharedAudioRawDataReceived:

◆ onShareNetworkStatusChanged:isSendingShare:

◆ onShareSettingChanged:

◆ onSpokenLanguageChanged:

◆ onSpotlightVideoChanged:userList:

◆ onSSLCertVerifiedFailNotification:

◆ onStartBroadcastResponse:channelID:

◆ onStartIncomingLiveStreamResponse:streamKeyID:

◆ onStopBroadcastResponse:

◆ onStopIncomingLiveStreamResponse:streamKeyID:

◆ onStreamingJoinStatusChanged:

◆ onSubSessionManagerHandle:

◆ onSubSessionParticipantHandle:

◆ onSubSessionStatusChanged:subSessionKit:

◆ onSubSessionUserHelpRequest:

◆ onSubSessionUserHelpRequestResult:

◆ onSubSessionUsersUpdate:

◆ onTestMicStatusChanged:

◆ onUnbindIncomingLiveStreamResponse:streamKeyID:

◆ onUserActiveAudioChanged:userList:

◆ onUserAudioStatusChanged:userList:

◆ onUserHostChanged:user:

◆ onUserJoin:userList:

◆ onUserLeave:userList:

◆ onUserManagerChanged:

◆ onUserNameChanged:

◆ onUserNetworkStatusChanged:level:user: