A listener class that groups together the callbacks related to a session. See ZoomVideoSDK#addListener(ZoomVideoSDKDelegate). More...

Public Member Functions
void	onSessionJoin (ZMVideoSDKUser myself)
	Callback: Invoked when the current user joins the session.

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

void	onError (ZMVideoSDKErrors errorType, int details)
	Callback: Invoked when errors occur.

void	onUserJoin (ZMVideoSDKUserHelper userHelper, List< ZMVideoSDKUser > userArray)
	Callback: Invoked when a user joins the session.

void	onUserLeave (ZMVideoSDKUserHelper userHelper, List< ZMVideoSDKUser > userArray)
	Triggered when other users leave session.

void	onUserVideoStatusChanged (ZMVideoSDKVideoHelper videoHelper, List< ZMVideoSDKUser > userArray)
	Callback: Invoked when a user makes changes to their video, such as starting or stopping their video.

void	onUserAudioStatusChanged (ZMVideoSDKAudioHelper audioHelper, List< ZMVideoSDKUser > userArray)
	Callback: Invoked when a user makes changes to their audio, such as muting or unmuting their audio.

void	onUserHostChanged (ZMVideoSDKUserHelper userHelper, ZMVideoSDKUser user)
	Callback: Invoked when the session host changes.

void	onUserActiveAudioChanged (ZMVideoSDKAudioHelper audioHelper, List< ZMVideoSDKUser > userArray)
	Callback: Invoked when the active audio changes.

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

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

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

void	onMicSpeakerVolumeChanged (uint micVolume, uint speakerVolume)
	Notify the current mic or speaker volume 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	onMixedAudioRawDataReceived (ZMVideoSDKAudioRawData audioRawData)
	Callback: Invoked when mixed (all users) audio raw data received.

void	onOneWayAudioRawDataReceived (ZMVideoSDKAudioRawData audioRawData, ZMVideoSDKUser user)
	Callback: Invoked when individual user's audio raw data received.

void	onChatNewMessageNotify (ZMVideoSDKChatHelper chatHelper, ZMVideoSDKChatMessage messageItem)
	Callback: Invoked when receiving a chat message.

void	onChatDeleteMessageNotify (ZMVideoSDKChatHelper chatHelper, string msgID, ZMVideoSDKChatMessageDeleteType deleteBy)
	Callback: Invoked when a user deletes a chat message.

void	onCloudRecordingStatusChanged (ZMVideoSDKRecordingStatus status, ZMVideoSDKRecordingConsentHandler handler)

void	onUserRecordingConsentChanged (ZMVideoSDKUser user)

void	onUserShareStatusChanged (ZMVideoSDKShareHelper shareHelper, ZMVideoSDKUser user, ZMVideoSDKShareStatus status)
	Callback: Invoked when a user's share status changes.

Detailed Description

A listener class that groups together the callbacks related to a session. See ZoomVideoSDK#addListener(ZoomVideoSDKDelegate).

Definition at line 7 of file IZMVideoSDKDelegate.cs.

Member Function Documentation

◆ onChatDeleteMessageNotify()

void IZMVideoSDKDelegate.onChatDeleteMessageNotify	(	ZMVideoSDKChatHelper	chatHelper,
		string	msgID,
		ZMVideoSDKChatMessageDeleteType	deleteBy
	)

Callback: Invoked when a user deletes a chat message.

Parameters

chatHelper	Chat helper utility.
msgID	The deleted message's ID.
deleteBy	Indicates by whom the message was deleted, which is defined in `ZMVideoSDKChatMessageDeleteType`.

◆ onChatNewMessageNotify()

void IZMVideoSDKDelegate.onChatNewMessageNotify	(	ZMVideoSDKChatHelper	chatHelper,
		ZMVideoSDKChatMessage	messageItem
	)

Callback: Invoked when receiving a chat message.

Parameters

chatHelper	chat helper util
messageItem	`ZMVideoSDKChatMessage`

◆ onCloudRecordingStatusChanged()

void IZMVideoSDKDelegate.onCloudRecordingStatusChanged	(	ZMVideoSDKRecordingStatus	status,
		ZMVideoSDKRecordingConsentHandler	handler
	)

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

Parameters

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

◆ onError()

void IZMVideoSDKDelegate.onError	(	ZMVideoSDKErrors	errorType,
		int	details
	)

Callback: Invoked when errors occur.

Parameters

errorType	Provides error code associated with the error. See `ZMVideoSDKErrors` for more information.
details	Detailed errorCode.

◆ onHostAskUnmute()

void IZMVideoSDKDelegate.onHostAskUnmute ( )

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

◆ onMicSpeakerVolumeChanged()

void IZMVideoSDKDelegate.onMicSpeakerVolumeChanged	(	uint	micVolume,
		uint	speakerVolume
	)

Notify the current mic or speaker volume when testing.

Parameters

micVolume	Specify the volume of the mic.
speakerVolume	Specify the volume of the speaker.

◆ onMixedAudioRawDataReceived()

void IZMVideoSDKDelegate.onMixedAudioRawDataReceived ( ZMVideoSDKAudioRawData audioRawData )

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

Parameters

audioRawData The Raw audio data object.

◆ onOneWayAudioRawDataReceived()

void IZMVideoSDKDelegate.onOneWayAudioRawDataReceived	(	ZMVideoSDKAudioRawData	audioRawData,
		ZMVideoSDKUser	user
	)

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

Parameters

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

◆ onSelectedAudioDeviceChanged()

void IZMVideoSDKDelegate.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.

◆ onSessionJoin()

void IZMVideoSDKDelegate.onSessionJoin ( ZMVideoSDKUser myself )

Callback: Invoked when the current user joins the session.

◆ onSessionLeave()

void IZMVideoSDKDelegate.onSessionLeave ( )

Callback: Invoked when the current user leaves the session.

◆ onUserActiveAudioChanged()

void IZMVideoSDKDelegate.onUserActiveAudioChanged	(	ZMVideoSDKAudioHelper	audioHelper,
		List< ZMVideoSDKUser >	userArray
	)

Callback: Invoked when the active audio changes.

Parameters

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

◆ onUserAudioStatusChanged()

void IZMVideoSDKDelegate.onUserAudioStatusChanged	(	ZMVideoSDKAudioHelper	audioHelper,
		List< ZMVideoSDKUser >	userArray
	)

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

void IZMVideoSDKDelegate.onUserHostChanged	(	ZMVideoSDKUserHelper	userHelper,
		ZMVideoSDKUser	user
	)

Callback: Invoked when the session host changes.

Parameters

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

◆ onUserJoin()

void IZMVideoSDKDelegate.onUserJoin	(	ZMVideoSDKUserHelper	userHelper,
		List< ZMVideoSDKUser >	userArray
	)

Callback: Invoked when a user joins the session.

Parameters

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

◆ onUserLeave()

void IZMVideoSDKDelegate.onUserLeave	(	ZMVideoSDKUserHelper	userHelper,
		List< ZMVideoSDKUser >	userArray
	)

Triggered when other users leave session.

Parameters

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

◆ onUserManagerChanged()

void IZMVideoSDKDelegate.onUserManagerChanged ( ZMVideoSDKUser user )

Callback: Invoked when the manager of the session changes.

Parameters

user	The pointer of user object.

◆ onUserNameChanged()

void IZMVideoSDKDelegate.onUserNameChanged ( ZMVideoSDKUser user )

Callback: Invoked when a user changes their name.

Parameters

user	The pointer of user object.

◆ onUserRecordingConsentChanged()

void IZMVideoSDKDelegate.onUserRecordingConsentChanged ( ZMVideoSDKUser user )

Invoked when a user consent to individual recording.

Parameters

user	`ZMVideoSDKUser`

◆ onUserShareStatusChanged()

void IZMVideoSDKDelegate.onUserShareStatusChanged	(	ZMVideoSDKShareHelper	shareHelper,
		ZMVideoSDKUser	user,
		ZMVideoSDKShareStatus	status
	)

Callback: Invoked when a user's share status changes.

Parameters

shareHelper	Share helper utility.
user	The user object.
status	Indicates the current share status, which is defined in `ZMVideoSDKShareStatus`.

◆ onUserVideoStatusChanged()

void IZMVideoSDKDelegate.onUserVideoStatusChanged	(	ZMVideoSDKVideoHelper	videoHelper,
		List< ZMVideoSDKUser >	userArray
	)

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.

Public Member Functions

Detailed Description

Member Function Documentation

◆ onChatDeleteMessageNotify()

◆ onChatNewMessageNotify()

◆ onCloudRecordingStatusChanged()

◆ onError()

◆ onHostAskUnmute()

◆ onMicSpeakerVolumeChanged()

◆ onMixedAudioRawDataReceived()

◆ onOneWayAudioRawDataReceived()

◆ onSelectedAudioDeviceChanged()

◆ onSessionJoin()

◆ onSessionLeave()

◆ onUserActiveAudioChanged()

◆ onUserAudioStatusChanged()

◆ onUserHostChanged()

◆ onUserJoin()

◆ onUserLeave()

◆ onUserManagerChanged()

◆ onUserNameChanged()

◆ onUserRecordingConsentChanged()

◆ onUserShareStatusChanged()

◆ onUserVideoStatusChanged()