Talkback controller callback event. More...

#include <meeting_talkback_ctrl_interface.h>

Public Types
enum	TalkbackError { TALKBACK_ERROR_OK , TALKBACK_ERROR_NOPERMISSION , TALKBACK_ERROR_ALREADY_EXIST , TALKBACK_ERROR_COUNT_OVERFLOW , TALKBACK_ERROR_NOT_EXIST , TALKBACK_ERROR_REJECTED , TALKBACK_ERROR_TIMEOUT , TALKBACK_ERROR_UNKNOWN }
	Talkback error enum. More...

Public Member Functions
virtual	~IMeetingTalkbackCtrlEvent ()
virtual void	onCreateChannelResponse (const zchar_t *channelID, TalkbackError error)=0
	Callback event for create channel response.
virtual void	onDestroyChannelResponse (const zchar_t *channelID, TalkbackError error)=0
	Callback event for destroy channel response.
virtual void	onChannelUserJoinResponse (const zchar_t *channelID, unsigned int userID, TalkbackError error)=0
	Callback event for user joined channel response.
virtual void	onChannelUserLeaveResponse (const zchar_t *channelID, unsigned int userID, TalkbackError error)=0
	Callback event for user left channel response.
virtual void	onJoinTalkbackChannel (unsigned int inviterID)=0
	Callback event for already joined talkback channel.
virtual void	onLeaveTalkbackChannel (unsigned int inviterID)=0
	Callback event for already left talkback channel.
virtual void	onInviterAudioLevel (unsigned int inviterID, unsigned int audioLevel)=0
	Callback event for inviter audio level in talkback channel.

Detailed Description

Talkback controller callback event.

Definition at line 37 of file meeting_talkback_ctrl_interface.h.

Member Enumeration Documentation

◆ TalkbackError

enum IMeetingTalkbackCtrlEvent::TalkbackError

Talkback error enum.

Enumerator
TALKBACK_ERROR_OK	Operation executed successfully.
TALKBACK_ERROR_NOPERMISSION	Permission denied.
TALKBACK_ERROR_ALREADY_EXIST	The object being operated on already exists, Example: the invited user is already in the channel.
TALKBACK_ERROR_COUNT_OVERFLOW	The number of channels exceeded the limit.
TALKBACK_ERROR_NOT_EXIST	The object being operated on does not exist.
TALKBACK_ERROR_REJECTED	Operation denied.
TALKBACK_ERROR_TIMEOUT	Operation timed out.
TALKBACK_ERROR_UNKNOWN	Unknown reason.

Definition at line 45 of file meeting_talkback_ctrl_interface.h.

    {
        TALKBACK_ERROR_OK,
        TALKBACK_ERROR_NOPERMISSION,
        TALKBACK_ERROR_ALREADY_EXIST,
        TALKBACK_ERROR_COUNT_OVERFLOW,
        TALKBACK_ERROR_NOT_EXIST,
        TALKBACK_ERROR_REJECTED,
        TALKBACK_ERROR_TIMEOUT,
        TALKBACK_ERROR_UNKNOWN
    };

Constructor & Destructor Documentation

◆ ~IMeetingTalkbackCtrlEvent()

virtual IMeetingTalkbackCtrlEvent::~IMeetingTalkbackCtrlEvent ( )

inlinevirtual

Definition at line 40 of file meeting_talkback_ctrl_interface.h.

40{}

Member Function Documentation

◆ onChannelUserJoinResponse()

virtual void IMeetingTalkbackCtrlEvent::onChannelUserJoinResponse	(	const zchar_t *	channelID,
		unsigned int	userID,
		TalkbackError	error )

pure virtual

Callback event for user joined channel response.

Parameters

channelID	Specify the channel ID.
userID	Specify the user ID who joined the channel.
error	Specify the error code.

Note: Determine whether the user is successfully invited. Batch inviting users is asynchronous, so check this callback to verify the invitation result.

◆ onChannelUserLeaveResponse()

virtual void IMeetingTalkbackCtrlEvent::onChannelUserLeaveResponse	(	const zchar_t *	channelID,
		unsigned int	userID,
		TalkbackError	error )

pure virtual

Callback event for user left channel response.

Parameters

channelID	Specify the channel ID.
userID	Specify the user ID who left the channel.
error	Specify the error code.

Note: Determine whether the user is successfully removed. Batch removing users from channel is asynchronous, so check this callback to verify the removal result.

◆ onCreateChannelResponse()

virtual void IMeetingTalkbackCtrlEvent::onCreateChannelResponse	(	const zchar_t *	channelID,
		TalkbackError	error )

pure virtual

Callback event for create channel response.

Parameters

channelID	Specify the channel ID.
error	Specify the error code.

Note: Determine whether the channel is successfully created. CreateChannel is asynchronous, so check this callback to verify the creation result.

◆ onDestroyChannelResponse()

virtual void IMeetingTalkbackCtrlEvent::onDestroyChannelResponse	(	const zchar_t *	channelID,
		TalkbackError	error )

pure virtual

Callback event for destroy channel response.

Parameters

channelID	Specify the channel ID.
error	Specify the error code.

Note: Determine whether the channel is successfully destroyed. Batch destroy channels is asynchronous, so check this callback to verify the destruction result.

◆ onInviterAudioLevel()

virtual void IMeetingTalkbackCtrlEvent::onInviterAudioLevel	(	unsigned int	inviterID,
		unsigned int	audioLevel )

pure virtual

Callback event for inviter audio level in talkback channel.

Parameters

inviterID	Specify the inviter user ID.
audioLevel	Inviter audio volume, range 0-15.

◆ onJoinTalkbackChannel()

virtual void IMeetingTalkbackCtrlEvent::onJoinTalkbackChannel ( unsigned int inviterID )

pure virtual

Callback event for already joined talkback channel.

Parameters

inviterID Specify the inviter user ID who invited to join the channel.

Note: This event notifies you that you have already entered the talkback channel, and the inviter ID is inviterID.

◆ onLeaveTalkbackChannel()

virtual void IMeetingTalkbackCtrlEvent::onLeaveTalkbackChannel ( unsigned int inviterID )

pure virtual

Callback event for already left talkback channel.

Parameters

inviterID Specify the inviter user ID who invited to leave the channel.

Note: This event notifies you that you have left the talkback channel.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TalkbackError

Constructor & Destructor Documentation

◆ ~IMeetingTalkbackCtrlEvent()

Member Function Documentation

◆ onChannelUserJoinResponse()

◆ onChannelUserLeaveResponse()

◆ onCreateChannelResponse()

◆ onDestroyChannelResponse()

◆ onInviterAudioLevel()

◆ onJoinTalkbackChannel()

◆ onLeaveTalkbackChannel()