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

#include <zoom_video_sdk_delegate_interface.h>

Public Member Functions
virtual void	onSessionJoin ()=0
	Notification of joining the session.

virtual void	onSessionLeave ()=0
	Notification of leaving the session.

virtual void	onSessionLeave (ZoomVideoSDKSessionLeaveReason eReason)=0
	Notification of leaving the session with reason.

virtual void	onError (ZoomVideoSDKErrors errorCode, int detailErrorCode)=0
	Notification of errors occur when join session.

virtual void	onUserJoin (IZoomVideoSDKUserHelper pUserHelper, IVideoSDKVector< IZoomVideoSDKUser > *userList)=0
	Notification of a user joins the session.

virtual void	onUserLeave (IZoomVideoSDKUserHelper pUserHelper, IVideoSDKVector< IZoomVideoSDKUser > *userList)=0
	Notification of a user leaves the session.

virtual void	onUserVideoStatusChanged (IZoomVideoSDKVideoHelper pVideoHelper, IVideoSDKVector< IZoomVideoSDKUser > *userList)=0
	Notification of a user makes changes to their video, such as starting or stopping their video.

virtual void	onUserAudioStatusChanged (IZoomVideoSDKAudioHelper pAudioHelper, IVideoSDKVector< IZoomVideoSDKUser > *userList)=0
	Notification of a user makes changes to their audio, such as muting or unmuting their audio.

virtual void	onUserShareStatusChanged (IZoomVideoSDKShareHelper pShareHelper, IZoomVideoSDKUser pUser, IZoomVideoSDKShareAction *pShareAction)=0
	Notification of a user makes changes to their sharing status, such as starting screen sharing, starting view sharing, or stopping sharing.

virtual void	onShareContentChanged (IZoomVideoSDKShareHelper pShareHelper, IZoomVideoSDKUser pUser, IZoomVideoSDKShareAction *pShareAction)=0
	Notification of a user makes changes to their share content type, such as camera share switch to normal share. The share type can be found in ZoomVideoSDKShareType.

virtual void	onFailedToStartShare (IZoomVideoSDKShareHelper pShareHelper, IZoomVideoSDKUser pUser)=0
	Notification of a user failed to start sharing.

virtual void	onShareSettingChanged (ZoomVideoSDKShareSetting setting)=0
	Notification of share setting changed.

virtual void	onUserRecordingConsent (IZoomVideoSDKUser *pUser)=0
	Notification of a user consents to individual recording.

virtual void	onLiveStreamStatusChanged (IZoomVideoSDKLiveStreamHelper *pLiveStreamHelper, ZoomVideoSDKLiveStreamStatus status)=0
	Notification of a user makes changes to their live stream status.

virtual void	onChatNewMessageNotify (IZoomVideoSDKChatHelper pChatHelper, IZoomVideoSDKChatMessage messageItem)=0
	Notification of receiving a chat message.

virtual void	onUserHostChanged (IZoomVideoSDKUserHelper pUserHelper, IZoomVideoSDKUser pUser)=0
	Notification of the session host changes.

virtual void	onUserActiveAudioChanged (IZoomVideoSDKAudioHelper pAudioHelper, IVideoSDKVector< IZoomVideoSDKUser > *list)=0
	Notification of the active audio changes.

virtual void	onSessionNeedPassword (IZoomVideoSDKPasswordHandler *handler)=0
	Notification of the session requires a password to join.

virtual void	onSessionPasswordWrong (IZoomVideoSDKPasswordHandler *handler)=0
	Notification of the provided session password is wrong or invalid.

virtual void	onMixedAudioRawDataReceived (AudioRawData *data_)=0
	Notification of mixed (all users) audio raw data received.

virtual void	onOneWayAudioRawDataReceived (AudioRawData data_, IZoomVideoSDKUser pUser)=0
	Notification of individual user's audio raw data received.

virtual void	onSharedAudioRawDataReceived (AudioRawData *data_)=0
	Notification of receiving shared raw audio data.

virtual void	onUserManagerChanged (IZoomVideoSDKUser *pUser)=0
	Notification of the manager of the session changes.

virtual void	onUserNameChanged (IZoomVideoSDKUser *pUser)=0
	Notification of user name changed.

virtual void	onCameraControlRequestResult (IZoomVideoSDKUser *pUser, bool isApproved)=0
	Notification of the current user is granted camera control access.

virtual void	onCameraControlRequestReceived (IZoomVideoSDKUser pUser, ZoomVideoSDKCameraControlRequestType requestType, IZoomVideoSDKCameraControlRequestHandler pCameraControlRequestHandler)=0
	Notification of the current user has received a camera control request.

virtual void	onCommandReceived (IZoomVideoSDKUser sender, const zchar_t strCmd)=0
	Notification of receiving a message, data, or a command from the command channel.

virtual void	onCommandChannelConnectResult (bool isSuccess)=0
	Notification of the command channel is ready to be used.

virtual void	onInviteByPhoneStatus (PhoneStatus status, PhoneFailedReason reason)=0
	Notification of the invite by phone status changes to any other valid status such as Calling, Ringing, Success, or Failed.

virtual void	onCalloutJoinSuccess (IZoomVideoSDKUser pUser, const zchar_t phoneNumber)=0
	Notification of the callout user successfully joins the meeting.

virtual void	onCloudRecordingStatus (RecordingStatus status, IZoomVideoSDKRecordingConsentHandler *pHandler)=0
	Notification of cloud recording status has paused, stopped, resumed, or otherwise changed.

virtual void	onHostAskUnmute ()=0
	Notification of a host requests you to unmute yourself.

virtual void	onMultiCameraStreamStatusChanged (ZoomVideoSDKMultiCameraStreamStatus status, IZoomVideoSDKUser pUser, IZoomVideoSDKRawDataPipe pVideoPipe)=0
	Notification of someone in a given session enables or disables multi-camera. All participants in the session receive this callback.

virtual void	onMicSpeakerVolumeChanged (unsigned int micVolume, unsigned int speakerVolume)=0
	Notification of the current mic or speaker volume changed.

virtual void	onAudioLevelChanged (unsigned int level, bool bAudioSharing, IZoomVideoSDKUser *pUser)=0
	Notification of the audio level changes for a participant (excluding self).

virtual void	onAudioDeviceStatusChanged (ZoomVideoSDKAudioDeviceType type, ZoomVideoSDKAudioDeviceStatus status)=0
	Notification of mic device or speaker device status changed.

virtual void	onTestMicStatusChanged (ZoomVideoSDK_TESTMIC_STATUS status)=0
	Notification of the mic status changed when testing.

virtual void	onSelectedAudioDeviceChanged ()=0
	Notification of the selected mic/speaker device is changed when testing. Then the SDK will close the mic/speaker testing. The user shall restart the test manually if he still wants to test.

virtual void	onCameraListChanged ()=0
	Notification of the camera list has changed.

virtual void	onLiveTranscriptionStatus (ZoomVideoSDKLiveTranscriptionStatus status)=0
	Notification of live transcription status changes.

virtual void	onOriginalLanguageMsgReceived (ILiveTranscriptionMessageInfo *messageInfo)=0
	Notification of original language message received.

virtual void	onLiveTranscriptionMsgInfoReceived (ILiveTranscriptionMessageInfo *messageInfo)=0
	Notification of a live transcription message is received.

virtual void	onLiveTranscriptionMsgError (ILiveTranscriptionLanguage spokenLanguage, ILiveTranscriptionLanguage transcriptLanguage)=0
	Notification of a live translation error occurs.

virtual void	onSpokenLanguageChanged (ILiveTranscriptionLanguage *spokenLanguage)=0
	Notification of the spoken language has changed.

virtual void	onChatMsgDeleteNotification (IZoomVideoSDKChatHelper pChatHelper, const zchar_t msgID, ZoomVideoSDKChatMessageDeleteType deleteBy)=0
	Notification of a user deletes a chat message.

virtual void	onChatPrivilegeChanged (IZoomVideoSDKChatHelper *pChatHelper, ZoomVideoSDKChatPrivilegeType privilege)=0
	Notification of the chat privilege of participant has changed.

virtual void	onSendFileStatus (IZoomVideoSDKSendFile *file, const FileTransferStatus &status)=0
	Notification of send file status make change.

virtual void	onReceiveFileStatus (IZoomVideoSDKReceiveFile *file, const FileTransferStatus &status)=0
	Notification of receive file status changed.

virtual void	onProxyDetectComplete ()=0
	Notification of completing the proxy detection.

virtual void	onProxySettingNotification (IZoomVideoSDKProxySettingHandler *handler)=0
	Notification of the proxy requests to input the username and password.

virtual void	onSSLCertVerifiedFailNotification (IZoomVideoSDKSSLCertificateInfo *info)=0
	Notification of the SSL verified fail.

virtual void	onUserVideoNetworkStatusChanged (ZoomVideoSDKNetworkStatus status, IZoomVideoSDKUser *pUser)=0
	Notification of the user's video network quality changes.

virtual void	onShareNetworkStatusChanged (ZoomVideoSDKNetworkStatus shareNetworkStatus, bool isSendingShare)=0
	Notification of the current user's share network quality changes.

virtual void	onUserNetworkStatusChanged (ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser)=0
	Notification of user's network status changes for a specific data type.

virtual void	onUserOverallNetworkStatusChanged (ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser)=0
	Notification of user's overall network status changes.

virtual void	onCallCRCDeviceStatusChanged (ZoomVideoSDKCRCCallStatus status)=0
	Notification of the call CRC device's status changed.

virtual void	onVideoCanvasSubscribeFail (ZoomVideoSDKSubscribeFailReason fail_reason, IZoomVideoSDKUser pUser, void handle)=0
	Notification of the subscribed user's video failure reason.

virtual void	onShareCanvasSubscribeFail (IZoomVideoSDKUser pUser, void handle, IZoomVideoSDKShareAction *pShareAction)=0
	Notification of the subscribed user's share view failure reason.

virtual void	onAnnotationHelperCleanUp (IZoomVideoSDKAnnotationHelper *helper)=0
	Notification of the annotation helper clean up.

virtual void	onAnnotationPrivilegeChange (IZoomVideoSDKUser pUser, IZoomVideoSDKShareAction pShareAction)=0
	Notification of the annotation privilege change.

virtual void	onAnnotationHelperActived (void *handle)=0
	Notification of the annotation helper activated. Notify that annotation windows have been created.

virtual void	onVideoAlphaChannelStatusChanged (bool isAlphaModeOn)=0
	Notification of video alpha channel mode changed.

virtual void	onSpotlightVideoChanged (IZoomVideoSDKVideoHelper pVideoHelper, IVideoSDKVector< IZoomVideoSDKUser > *userList)=0
	Notification of spotlighted video user changed.

virtual void	onBindIncomingLiveStreamResponse (bool bSuccess, const zchar_t *strStreamKeyID)=0
	Notification of the response that binding the incoming live stream.

virtual void	onUnbindIncomingLiveStreamResponse (bool bSuccess, const zchar_t *strStreamKeyID)=0
	Notification of the response that unbinding the incoming live stream.

virtual void	onIncomingLiveStreamStatusResponse (bool bSuccess, IVideoSDKVector< IncomingLiveStreamStatus > *pStreamsStatusList)=0
	Notification of the response that gets the streams status.

virtual void	onStartIncomingLiveStreamResponse (bool bSuccess, const zchar_t *strStreamKeyID)=0
	Notification of the response that starts the bound stream.

virtual void	onStopIncomingLiveStreamResponse (bool bSuccess, const zchar_t *strStreamKeyID)=0
	Notification of the response that stops the bound stream.

virtual void	onShareContentSizeChanged (IZoomVideoSDKShareHelper pShareHelper, IZoomVideoSDKUser pUser, IZoomVideoSDKShareAction *pShareAction)=0
	Notification of the share content size has changed.

virtual void	onSubSessionStatusChanged (ZoomVideoSDKSubSessionStatus status, IVideoSDKVector< ISubSessionKit * > *pSubSessionKitList)=0
	Notification of the subsession status changed.

virtual void	onSubSessionManagerHandle (IZoomVideoSDKSubSessionManager *pManager)=0
	Notification of the user has subsession manager privilege.

virtual void	onSubSessionParticipantHandle (IZoomVideoSDKSubSessionParticipant *pParticipant)=0
	Notification of a user gains or loses subsession participant privileges.

virtual void	onSubSessionUsersUpdate (ISubSessionKit *pSubSessionKit)=0
	Notification of the subsession users are updated..

virtual void	onBroadcastMessageFromMainSession (const zchar_t sMessage, const zchar_t sUserName)=0
	Notification of the user receives a main session broadcast message.

virtual void	onSubSessionUserHelpRequest (ISubSessionUserHelpRequestHandler *pHandler)=0
	Notification of the user receives a help request from a subsession.

virtual void	onSubSessionUserHelpRequestResult (ZoomVideoSDKUserHelpRequestResult eResult)=0
	Notification of the result of the help request.

virtual void	onStartBroadcastResponse (bool bSuccess, const zchar_t *channelID)=0
	Notification the response of starting broadcast streaming.

virtual void	onStopBroadcastResponse (bool bSuccess)=0
	Notification the response of stopping broadcast streaming.

virtual void	onGetBroadcastControlStatus (bool bSuccess, ZoomVideoSDKBroadcastControlStatus status)=0
	Notification the response of getting broadcast status.

virtual void	onStreamingJoinStatusChanged (ZoomVideoSDKStreamingJoinStatus status)=0
	Notification when the viewer's join status changes.

virtual void	onWhiteboardExported (ZoomVideoSDKExportFormat format, unsigned char *data, long length)=0
	Callback invoked when a whiteboard file export completes.

virtual void	onUserWhiteboardShareStatusChanged (IZoomVideoSDKUser pUser, IZoomVideoSDKWhiteboardHelper pWhiteboardHelper)=0
	Callback invoked when a user changes their whiteboard sharing status, such as starting or stopping whiteboard sharing.

virtual void	onRealTimeMediaStreamsStatus (RealTimeMediaStreamsStatus status)=0
	Notification of the real-time media stream's status changed.

virtual void	onRealTimeMediaStreamsFail (RealTimeMediaStreamsFailReason failReason)=0
	Notification of the real-time media stream failure reason.

Detailed Description

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

Definition at line 37 of file zoom_video_sdk_delegate_interface.h.

Member Function Documentation

◆ onAnnotationHelperActived()

virtual void IZoomVideoSDKDelegate::onAnnotationHelperActived ( void * handle )

pure virtual

Notification of the annotation helper activated. Notify that annotation windows have been created.

Parameters

handle The window handle that annotating.

◆ onAnnotationHelperCleanUp()

virtual void IZoomVideoSDKDelegate::onAnnotationHelperCleanUp ( IZoomVideoSDKAnnotationHelper * helper )

pure virtual

Notification of the annotation helper clean up.

Parameters

helper The clean up object.

Note: After this callback, SDK will release the ZoomVideoSDKAnnotationHelper as well.

◆ onAnnotationPrivilegeChange()

virtual void IZoomVideoSDKDelegate::onAnnotationPrivilegeChange	(	IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKShareAction *	pShareAction )

pure virtual

Notification of the annotation privilege change.

Parameters

pUser	The pointer to a user object.
IZoomVideoSDKShareAction	The pointer to share object.

◆ onAudioDeviceStatusChanged()

virtual void IZoomVideoSDKDelegate::onAudioDeviceStatusChanged	(	ZoomVideoSDKAudioDeviceType	type,
		ZoomVideoSDKAudioDeviceStatus	status )

pure virtual

Notification of mic device or speaker device status changed.

Parameters

type.
status.

◆ onAudioLevelChanged()

virtual void IZoomVideoSDKDelegate::onAudioLevelChanged	(	unsigned int	level,
		bool	bAudioSharing,
		IZoomVideoSDKUser *	pUser )

pure virtual

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	true 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()

virtual void IZoomVideoSDKDelegate::onBindIncomingLiveStreamResponse	(	bool	bSuccess,
		const zchar_t *	strStreamKeyID )

pure virtual

Notification of the response that binding the incoming live stream.

Parameters

bSuccess	true: success, otherwise false.
strStreamKeyID	Corresponding stream key ID.

◆ onBroadcastMessageFromMainSession()

virtual void IZoomVideoSDKDelegate::onBroadcastMessageFromMainSession	(	const zchar_t *	sMessage,
		const zchar_t *	sUserName )

pure virtual

Notification of the user receives a main session broadcast message.

Parameters

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

◆ onCallCRCDeviceStatusChanged()

virtual void IZoomVideoSDKDelegate::onCallCRCDeviceStatusChanged ( ZoomVideoSDKCRCCallStatus status )

pure virtual

Notification of the call CRC device's status changed.

Parameters

status The call status.

◆ onCalloutJoinSuccess()

virtual void IZoomVideoSDKDelegate::onCalloutJoinSuccess	(	IZoomVideoSDKUser *	pUser,
		const zchar_t *	phoneNumber )

pure virtual

Notification of the callout user successfully joins the meeting.

Parameters

pUser	The invited user who joined the meeting.
phoneNumber	The phone number involved in the callout.

◆ onCameraControlRequestReceived()

virtual void IZoomVideoSDKDelegate::onCameraControlRequestReceived	(	IZoomVideoSDKUser *	pUser,
		ZoomVideoSDKCameraControlRequestType	requestType,
		IZoomVideoSDKCameraControlRequestHandler *	pCameraControlRequestHandler )

pure virtual

Notification of the current user has received a camera control request.

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

Parameters

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

◆ onCameraControlRequestResult()

virtual void IZoomVideoSDKDelegate::onCameraControlRequestResult	(	IZoomVideoSDKUser *	pUser,
		bool	isApproved )

pure virtual

Notification of 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

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

◆ onCameraListChanged()

virtual void IZoomVideoSDKDelegate::onCameraListChanged ( )

pure virtual

Notification of the camera list has changed.

◆ onChatMsgDeleteNotification()

virtual void IZoomVideoSDKDelegate::onChatMsgDeleteNotification	(	IZoomVideoSDKChatHelper *	pChatHelper,
		const zchar_t *	msgID,
		ZoomVideoSDKChatMessageDeleteType	deleteBy )

pure virtual

Notification of a user deletes a chat message.

Parameters

pChatHelper	Chat helper utility.
MsgID	The deleted message's ID.
deleteBy	Indicates by whom the message was deleted.

◆ onChatNewMessageNotify()

virtual void IZoomVideoSDKDelegate::onChatNewMessageNotify	(	IZoomVideoSDKChatHelper *	pChatHelper,
		IZoomVideoSDKChatMessage *	messageItem )

pure virtual

Notification of receiving a chat message.

Parameters

pChatHelper	The pointer to chat helper object.
messageItem	The pointer to message object.

◆ onChatPrivilegeChanged()

virtual void IZoomVideoSDKDelegate::onChatPrivilegeChanged	(	IZoomVideoSDKChatHelper *	pChatHelper,
		ZoomVideoSDKChatPrivilegeType	privilege )

pure virtual

Notification of the chat privilege of participant has changed.

Parameters

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

◆ onCloudRecordingStatus()

virtual void IZoomVideoSDKDelegate::onCloudRecordingStatus	(	RecordingStatus	status,
		IZoomVideoSDKRecordingConsentHandler *	pHandler )

pure virtual

Notification of cloud recording status has paused, stopped, resumed, or otherwise changed.

Parameters

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

◆ onCommandChannelConnectResult()

virtual void IZoomVideoSDKDelegate::onCommandChannelConnectResult ( bool isSuccess )

pure virtual

Notification of the command channel is ready to be used.

Note: 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 true: success, command channel is ready to be used. false: Failure, command channel was unable to connect.

◆ onCommandReceived()

virtual void IZoomVideoSDKDelegate::onCommandReceived	(	IZoomVideoSDKUser *	sender,
		const zchar_t *	strCmd )

pure virtual

Notification of receiving a message, data, or a command from the command channel.

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

Parameters

pSender	The user who sent the command.
strCmd	Received command.

◆ onError()

virtual void IZoomVideoSDKDelegate::onError	(	ZoomVideoSDKErrors	errorCode,
		int	detailErrorCode )

pure virtual

Notification of errors occur when join session.

Parameters

errorCode.
detailErrorCode	Detailed errorCode.

◆ onFailedToStartShare()

virtual void IZoomVideoSDKDelegate::onFailedToStartShare	(	IZoomVideoSDKShareHelper *	pShareHelper,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of a user failed to start sharing.

Parameters

pShareHelper	The pointer to share helper object.
pUser	The pointer to user object.

◆ onGetBroadcastControlStatus()

virtual void IZoomVideoSDKDelegate::onGetBroadcastControlStatus	(	bool	bSuccess,
		ZoomVideoSDKBroadcastControlStatus	status )

pure virtual

Notification the response of getting broadcast status.

Parameters

bSuccess	true if the request succeeded; otherwise false.
status	The current broadcast status, see ZoomVideoSDKBroadcastControlStatus.

◆ onHostAskUnmute()

virtual void IZoomVideoSDKDelegate::onHostAskUnmute ( )

pure virtual

Notification of a host requests you to unmute yourself.

◆ onIncomingLiveStreamStatusResponse()

virtual void IZoomVideoSDKDelegate::onIncomingLiveStreamStatusResponse	(	bool	bSuccess,
		IVideoSDKVector< IncomingLiveStreamStatus > *	pStreamsStatusList )

pure virtual

Notification of the response that gets the streams status.

Parameters

bSuccess	true: success, otherwise false.
pStreamsStatusList	The streams status list.

◆ onInviteByPhoneStatus()

virtual void IZoomVideoSDKDelegate::onInviteByPhoneStatus	(	PhoneStatus	status,
		PhoneFailedReason	reason )

pure virtual

Notification of 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	IInvite by phone failed reason.

◆ onLiveStreamStatusChanged()

virtual void IZoomVideoSDKDelegate::onLiveStreamStatusChanged	(	IZoomVideoSDKLiveStreamHelper *	pLiveStreamHelper,
		ZoomVideoSDKLiveStreamStatus	status )

pure virtual

Notification of a user makes changes to their live stream status.

Parameters

pLiveStreamHelper	The pointer to live stream helper object.
status	The current status of live stream.

◆ onLiveTranscriptionMsgError()

virtual void IZoomVideoSDKDelegate::onLiveTranscriptionMsgError	(	ILiveTranscriptionLanguage *	spokenLanguage,
		ILiveTranscriptionLanguage *	transcriptLanguage )

pure virtual

Notification of a live translation error occurs.

Parameters

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

◆ onLiveTranscriptionMsgInfoReceived()

virtual void IZoomVideoSDKDelegate::onLiveTranscriptionMsgInfoReceived ( ILiveTranscriptionMessageInfo * messageInfo )

pure virtual

Notification of a live transcription message is received.

Parameters

messageInfo The live transcription message.

◆ onLiveTranscriptionStatus()

virtual void IZoomVideoSDKDelegate::onLiveTranscriptionStatus ( ZoomVideoSDKLiveTranscriptionStatus status )

pure virtual

Notification of live transcription status changes.

Parameters

status The live transcription status.

◆ onMicSpeakerVolumeChanged()

virtual void IZoomVideoSDKDelegate::onMicSpeakerVolumeChanged	(	unsigned int	micVolume,
		unsigned int	speakerVolume )

pure virtual

Notification of the current mic or speaker volume changed.

Parameters

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

◆ onMixedAudioRawDataReceived()

virtual void IZoomVideoSDKDelegate::onMixedAudioRawDataReceived ( AudioRawData * data_ )

pure virtual

Notification of mixed (all users) audio raw data received.

Parameters

data_ The pointer to audio raw data.

◆ onMultiCameraStreamStatusChanged()

virtual void IZoomVideoSDKDelegate::onMultiCameraStreamStatusChanged	(	ZoomVideoSDKMultiCameraStreamStatus	status,
		IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKRawDataPipe *	pVideoPipe )

pure virtual

Notification of someone in a given session enables or disables multi-camera. All participants in the session receive this callback.

Parameters

status.
pUser	The user who enabled multi-camera.
pVideoPipe	The data pipe for the multi-camera.

◆ onOneWayAudioRawDataReceived()

virtual void IZoomVideoSDKDelegate::onOneWayAudioRawDataReceived	(	AudioRawData *	data_,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of individual user's audio raw data received.

Parameters

data_	Raw audio data.
pUser	The pointer to user object associated with the raw audio data.

◆ onOriginalLanguageMsgReceived()

virtual void IZoomVideoSDKDelegate::onOriginalLanguageMsgReceived ( ILiveTranscriptionMessageInfo * messageInfo )

pure virtual

Notification of original language message received.

Parameters

messageInfo The spoken language message.

◆ onProxyDetectComplete()

virtual void IZoomVideoSDKDelegate::onProxyDetectComplete ( )

pure virtual

Notification of completing the proxy detection.

◆ onProxySettingNotification()

virtual void IZoomVideoSDKDelegate::onProxySettingNotification ( IZoomVideoSDKProxySettingHandler * handler )

pure virtual

Notification of the proxy requests to input the username and password.

Note: Use the handler to configure the related information.

Parameters

handler The pointer to the IZoomVideoSDKProxySettingHandler.

◆ onRealTimeMediaStreamsFail()

virtual void IZoomVideoSDKDelegate::onRealTimeMediaStreamsFail ( RealTimeMediaStreamsFailReason failReason )

pure virtual

Notification of the real-time media stream failure reason.

Parameters

failReason The real-time media stream failure reason.

◆ onRealTimeMediaStreamsStatus()

virtual void IZoomVideoSDKDelegate::onRealTimeMediaStreamsStatus ( RealTimeMediaStreamsStatus status )

pure virtual

Notification of the real-time media stream's status changed.

Parameters

status The real-time media streams status. For more details, see RealTimeMediaStreamsStatus enum.

◆ onReceiveFileStatus()

virtual void IZoomVideoSDKDelegate::onReceiveFileStatus	(	IZoomVideoSDKReceiveFile *	file,
		const FileTransferStatus &	status )

pure virtual

Notification of receive file status changed.

Parameters

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

◆ onSelectedAudioDeviceChanged()

virtual void IZoomVideoSDKDelegate::onSelectedAudioDeviceChanged ( )

pure virtual

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

◆ onSendFileStatus()

virtual void IZoomVideoSDKDelegate::onSendFileStatus	(	IZoomVideoSDKSendFile *	file,
		const FileTransferStatus &	status )

pure virtual

Notification of send file status make change.

Parameters

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

◆ onSessionJoin()

virtual void IZoomVideoSDKDelegate::onSessionJoin ( )

pure virtual

Notification of joining the session.

◆ onSessionLeave() [1/2]

virtual void IZoomVideoSDKDelegate::onSessionLeave ( )

pure virtual

Notification of leaving the session.

Deprecated: This interface is marked as deprecated. Use onSessionLeave(ZoomVideoSDKSessionLeaveReason eReason) instead.

◆ onSessionLeave() [2/2]

virtual void IZoomVideoSDKDelegate::onSessionLeave ( ZoomVideoSDKSessionLeaveReason eReason )

pure virtual

Notification of leaving the session with reason.

Parameters

eReason.

◆ onSessionNeedPassword()

virtual void IZoomVideoSDKDelegate::onSessionNeedPassword ( IZoomVideoSDKPasswordHandler * handler )

pure virtual

Notification of the session requires a password to join.

Parameters

handler The pointer to password handler object.

◆ onSessionPasswordWrong()

virtual void IZoomVideoSDKDelegate::onSessionPasswordWrong ( IZoomVideoSDKPasswordHandler * handler )

pure virtual

Notification of the provided session password is wrong or invalid.

Parameters

handler The pointer to password handler object.

◆ onShareCanvasSubscribeFail()

virtual void IZoomVideoSDKDelegate::onShareCanvasSubscribeFail	(	IZoomVideoSDKUser *	pUser,
		void *	handle,
		IZoomVideoSDKShareAction *	pShareAction )

pure virtual

Notification of the subscribed user's share view failure reason.

Parameters

pUser	The pointer to a user object.
handle	The window handle that failed to subscribe.
IZoomVideoSDKShareAction	The pointer to share object.

◆ onShareContentChanged()

virtual void IZoomVideoSDKDelegate::onShareContentChanged	(	IZoomVideoSDKShareHelper *	pShareHelper,
		IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKShareAction *	pShareAction )

pure virtual

Notification of a user makes changes to their share content type, such as camera share switch to normal share. The share type can be found in ZoomVideoSDKShareType.

Parameters

pShareHelper	The pointer to share helper object.
pUser	The pointer to user object.
IZoomVideoSDKShareAction	The pointer to share object.

◆ onShareContentSizeChanged()

virtual void IZoomVideoSDKDelegate::onShareContentSizeChanged	(	IZoomVideoSDKShareHelper *	pShareHelper,
		IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKShareAction *	pShareAction )

pure virtual

Notification of the share content size has changed.

Parameters

pShareHelper	The pointer to the share helper object.
pUser	The pointer to a user object.
pShareAction	The pointer to the share 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()

virtual void IZoomVideoSDKDelegate::onSharedAudioRawDataReceived ( AudioRawData * data_ )

pure virtual

Notification of receiving shared raw audio data.

Parameters

data_ Raw audio data.

◆ onShareNetworkStatusChanged()

virtual void IZoomVideoSDKDelegate::onShareNetworkStatusChanged	(	ZoomVideoSDKNetworkStatus	shareNetworkStatus,
		bool	isSendingShare )

pure virtual

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

Parameters

shareNetworkStatus	share network quality.
isSendingShare	Indicates the direction of the share. If true, it refers to the sending share; if false, it refers to the receiving share.

Deprecated: This interface is marked as deprecated. Use onUserNetworkStatusChanged(ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser) instead.

◆ onShareSettingChanged()

virtual void IZoomVideoSDKDelegate::onShareSettingChanged ( ZoomVideoSDKShareSetting setting )

pure virtual

Notification of share setting changed.

Parameters

setting The share setting.

◆ onSpokenLanguageChanged()

virtual void IZoomVideoSDKDelegate::onSpokenLanguageChanged ( ILiveTranscriptionLanguage * spokenLanguage )

pure virtual

Notification of the spoken language has changed.

Parameters

spokenLanguage The spoken message language.

◆ onSpotlightVideoChanged()

virtual void IZoomVideoSDKDelegate::onSpotlightVideoChanged	(	IZoomVideoSDKVideoHelper *	pVideoHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	userList )

pure virtual

Notification of spotlighted video user changed.

Parameters

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

◆ onSSLCertVerifiedFailNotification()

virtual void IZoomVideoSDKDelegate::onSSLCertVerifiedFailNotification ( IZoomVideoSDKSSLCertificateInfo * info )

pure virtual

Notification of the SSL verified fail.

Parameters

info	The info of SSL certificate related information.

◆ onStartBroadcastResponse()

virtual void IZoomVideoSDKDelegate::onStartBroadcastResponse	(	bool	bSuccess,
		const zchar_t *	channelID )

pure virtual

Notification the response of starting broadcast streaming.

Parameters

bSuccess	true if broadcast streaming started successfully; otherwise false.
channelID	This broadcast streaming channel ID returned by the backend.

◆ onStartIncomingLiveStreamResponse()

virtual void IZoomVideoSDKDelegate::onStartIncomingLiveStreamResponse	(	bool	bSuccess,
		const zchar_t *	strStreamKeyID )

pure virtual

Notification of the response that starts the bound stream.

Parameters

bSuccess	true: success, otherwise false.
strStreamKeyID	Corresponding stream key ID.

◆ onStopBroadcastResponse()

virtual void IZoomVideoSDKDelegate::onStopBroadcastResponse ( bool bSuccess )

pure virtual

Notification the response of stopping broadcast streaming.

Parameters

bSuccess true if broadcast stopped successfully; otherwise false.

◆ onStopIncomingLiveStreamResponse()

virtual void IZoomVideoSDKDelegate::onStopIncomingLiveStreamResponse	(	bool	bSuccess,
		const zchar_t *	strStreamKeyID )

pure virtual

Notification of the response that stops the bound stream.

Parameters

bSuccess	true: success, otherwise false.
strStreamKeyID	Corresponding stream key ID.

◆ onStreamingJoinStatusChanged()

virtual void IZoomVideoSDKDelegate::onStreamingJoinStatusChanged ( ZoomVideoSDKStreamingJoinStatus status )

pure virtual

Notification when the viewer's join status changes.

Parameters

status The current join status. See ZoomVideoSDKStreamingJoinStatus.

◆ onSubSessionManagerHandle()

virtual void IZoomVideoSDKDelegate::onSubSessionManagerHandle ( IZoomVideoSDKSubSessionManager * pManager )

pure virtual

Notification of the user has subsession manager privilege.

Parameters

pManager The subsession manager object.

◆ onSubSessionParticipantHandle()

virtual void IZoomVideoSDKDelegate::onSubSessionParticipantHandle ( IZoomVideoSDKSubSessionParticipant * pParticipant )

pure virtual

Notification of a user gains or loses subsession participant privileges.

Parameters

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

◆ onSubSessionStatusChanged()

virtual void IZoomVideoSDKDelegate::onSubSessionStatusChanged	(	ZoomVideoSDKSubSessionStatus	status,
		IVideoSDKVector< ISubSessionKit * > *	pSubSessionKitList )

pure virtual

Notification of the subsession status changed.

Parameters

status	The subsession status.
pSubSessionKitList	The new subsession list.

◆ onSubSessionUserHelpRequest()

virtual void IZoomVideoSDKDelegate::onSubSessionUserHelpRequest ( ISubSessionUserHelpRequestHandler * pHandler )

pure virtual

Notification of the user receives a help request from a subsession.

Parameters

pHandler The request handler object.

◆ onSubSessionUserHelpRequestResult()

virtual void IZoomVideoSDKDelegate::onSubSessionUserHelpRequestResult ( ZoomVideoSDKUserHelpRequestResult eResult )

pure virtual

Notification of the result of the help request.

Parameters

eResult The result of help request.

◆ onSubSessionUsersUpdate()

virtual void IZoomVideoSDKDelegate::onSubSessionUsersUpdate ( ISubSessionKit * pSubSessionKit )

pure virtual

Notification of the subsession users are updated..

Parameters

pSubSessionKit The subsession kit object.

◆ onTestMicStatusChanged()

virtual void IZoomVideoSDKDelegate::onTestMicStatusChanged ( ZoomVideoSDK_TESTMIC_STATUS status )

pure virtual

Notification of the mic status changed when testing.

Parameters

status The mic status.

Note: The enuCanPlay status indicates that the SDK has recorded the microphone sound for the longest time (6 seconds).customers can decide for themselves whether to stop test mic or play microphone sound.

◆ onUnbindIncomingLiveStreamResponse()

virtual void IZoomVideoSDKDelegate::onUnbindIncomingLiveStreamResponse	(	bool	bSuccess,
		const zchar_t *	strStreamKeyID )

pure virtual

Notification of the response that unbinding the incoming live stream.

Parameters

bSuccess	true: success, otherwise false.
strStreamKeyID	Corresponding stream key ID.

◆ onUserActiveAudioChanged()

virtual void IZoomVideoSDKDelegate::onUserActiveAudioChanged	(	IZoomVideoSDKAudioHelper *	pAudioHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	list )

pure virtual

Notification of the active audio changes.

Parameters

pAudioHelper	Audio helper utility.
list	Active audio list.

◆ onUserAudioStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserAudioStatusChanged	(	IZoomVideoSDKAudioHelper *	pAudioHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	userList )

pure virtual

Notification of a user makes changes to their audio, such as muting or unmuting their audio.

Parameters

pAudioHelper	The pointer to audio helper object.
userList	The pointer to user object list.

◆ onUserHostChanged()

virtual void IZoomVideoSDKDelegate::onUserHostChanged	(	IZoomVideoSDKUserHelper *	pUserHelper,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of the session host changes.

Parameters

pUserHelper	The pointer to user helper object.
pUser	The pointer to user object.

◆ onUserJoin()

virtual void IZoomVideoSDKDelegate::onUserJoin	(	IZoomVideoSDKUserHelper *	pUserHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	userList )

pure virtual

Notification of a user joins the session.

Parameters

pUserHelper	User helper utility.
userList	List of users who have just joined the session.

◆ onUserLeave()

virtual void IZoomVideoSDKDelegate::onUserLeave	(	IZoomVideoSDKUserHelper *	pUserHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	userList )

pure virtual

Notification of a user leaves the session.

Parameters

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

◆ onUserManagerChanged()

virtual void IZoomVideoSDKDelegate::onUserManagerChanged ( IZoomVideoSDKUser * pUser )

pure virtual

Notification of the manager of the session changes.

Parameters

pUser The pointer to user object.

◆ onUserNameChanged()

virtual void IZoomVideoSDKDelegate::onUserNameChanged ( IZoomVideoSDKUser * pUser )

pure virtual

Notification of user name changed.

Parameters

pUser The pointer to user object.

◆ onUserNetworkStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserNetworkStatusChanged	(	ZoomVideoSDKDataType	type,
		ZoomVideoSDKNetworkStatus	level,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of 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.
pUser	The user whose network status has changed.

◆ onUserOverallNetworkStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserOverallNetworkStatusChanged	(	ZoomVideoSDKNetworkStatus	level,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of user's overall network status changes.

Parameters

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

◆ onUserRecordingConsent()

virtual void IZoomVideoSDKDelegate::onUserRecordingConsent ( IZoomVideoSDKUser * pUser )

pure virtual

Notification of a user consents to individual recording.

Parameters

pUser The pointer to user object.

◆ onUserShareStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserShareStatusChanged	(	IZoomVideoSDKShareHelper *	pShareHelper,
		IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKShareAction *	pShareAction )

pure virtual

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

Parameters

pShareHelper	The pointer to share helper object.
pUser	The pointer to user object.
IZoomVideoSDKShareAction	The pointer to share object.

◆ onUserVideoNetworkStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserVideoNetworkStatusChanged	(	ZoomVideoSDKNetworkStatus	status,
		IZoomVideoSDKUser *	pUser )

pure virtual

Notification of the user's video network quality changes.

Parameters

status	video network quality.
pUser	The pointer to a user object.

Deprecated: This interface is marked as deprecated. Use onUserNetworkStatusChanged(ZoomVideoSDKDataType type, ZoomVideoSDKNetworkStatus level, IZoomVideoSDKUser *pUser) instead.

◆ onUserVideoStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserVideoStatusChanged	(	IZoomVideoSDKVideoHelper *	pVideoHelper,
		IVideoSDKVector< IZoomVideoSDKUser * > *	userList )

pure virtual

Notification of a user makes changes to their video, such as starting or stopping their video.

Parameters

pVideoHelper	The pointer to video helper object.
userList	The pointer to user object list.

◆ onUserWhiteboardShareStatusChanged()

virtual void IZoomVideoSDKDelegate::onUserWhiteboardShareStatusChanged	(	IZoomVideoSDKUser *	pUser,
		IZoomVideoSDKWhiteboardHelper *	pWhiteboardHelper )

pure virtual

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

Parameters

pUser	The user who's whiteboard sharing status changed. Check the current status via IZoomVideoSDKUser.
pWhiteboardHelper	The whiteboard helper object.

◆ onVideoAlphaChannelStatusChanged()

virtual void IZoomVideoSDKDelegate::onVideoAlphaChannelStatusChanged ( bool isAlphaModeOn )

pure virtual

Notification of video alpha channel mode changed.

Parameters

isAlphaModeOn Indicates the state of the alpha channel mode. If true, it is enabled; if false, it is disabled.

◆ onVideoCanvasSubscribeFail()

virtual void IZoomVideoSDKDelegate::onVideoCanvasSubscribeFail	(	ZoomVideoSDKSubscribeFailReason	fail_reason,
		IZoomVideoSDKUser *	pUser,
		void *	handle )

pure virtual

Notification of the subscribed user's video failure reason.

Parameters

fail_reason	The user's video subscribe failure reason.
pUser	The pointer to a user object.
handle	The window handle that failed to subscribe.

◆ onWhiteboardExported()

virtual void IZoomVideoSDKDelegate::onWhiteboardExported	(	ZoomVideoSDKExportFormat	format,
		unsigned char *	data,
		long	length )

pure virtual

Callback invoked when a whiteboard file export completes.

Parameters

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ onAnnotationHelperActived()

◆ onAnnotationHelperCleanUp()

◆ onAnnotationPrivilegeChange()

◆ onAudioDeviceStatusChanged()

◆ onAudioLevelChanged()

◆ onBindIncomingLiveStreamResponse()

◆ onBroadcastMessageFromMainSession()

◆ onCallCRCDeviceStatusChanged()

◆ onCalloutJoinSuccess()

◆ onCameraControlRequestReceived()

◆ onCameraControlRequestResult()

◆ onCameraListChanged()

◆ onChatMsgDeleteNotification()

◆ onChatNewMessageNotify()

◆ onChatPrivilegeChanged()

◆ onCloudRecordingStatus()

◆ onCommandChannelConnectResult()

◆ onCommandReceived()

◆ onError()

◆ onFailedToStartShare()

◆ onGetBroadcastControlStatus()

◆ onHostAskUnmute()

◆ onIncomingLiveStreamStatusResponse()

◆ onInviteByPhoneStatus()

◆ onLiveStreamStatusChanged()

◆ onLiveTranscriptionMsgError()

◆ onLiveTranscriptionMsgInfoReceived()

◆ onLiveTranscriptionStatus()

◆ onMicSpeakerVolumeChanged()

◆ onMixedAudioRawDataReceived()

◆ onMultiCameraStreamStatusChanged()

◆ onOneWayAudioRawDataReceived()

◆ onOriginalLanguageMsgReceived()

◆ onProxyDetectComplete()

◆ onProxySettingNotification()

◆ onRealTimeMediaStreamsFail()

◆ onRealTimeMediaStreamsStatus()

◆ onReceiveFileStatus()

◆ onSelectedAudioDeviceChanged()

◆ onSendFileStatus()

◆ onSessionJoin()

◆ onSessionLeave() [1/2]

◆ onSessionLeave() [2/2]

◆ onSessionNeedPassword()

◆ onSessionPasswordWrong()

◆ onShareCanvasSubscribeFail()

◆ onShareContentChanged()

◆ onShareContentSizeChanged()

◆ onSharedAudioRawDataReceived()

◆ onShareNetworkStatusChanged()

◆ onShareSettingChanged()

◆ onSpokenLanguageChanged()

◆ onSpotlightVideoChanged()

◆ onSSLCertVerifiedFailNotification()

◆ onStartBroadcastResponse()

◆ onStartIncomingLiveStreamResponse()

◆ onStopBroadcastResponse()

◆ onStopIncomingLiveStreamResponse()

◆ onStreamingJoinStatusChanged()

◆ onSubSessionManagerHandle()

◆ onSubSessionParticipantHandle()

◆ onSubSessionStatusChanged()

◆ onSubSessionUserHelpRequest()

◆ onSubSessionUserHelpRequestResult()

◆ onSubSessionUsersUpdate()

◆ onTestMicStatusChanged()

◆ onUnbindIncomingLiveStreamResponse()

◆ onUserActiveAudioChanged()

◆ onUserAudioStatusChanged()

◆ onUserHostChanged()

◆ onUserJoin()

◆ onUserLeave()

◆ onUserManagerChanged()

◆ onUserNameChanged()

◆ onUserNetworkStatusChanged()

◆ onUserOverallNetworkStatusChanged()

◆ onUserRecordingConsent()