Meeting Service Interface. More...

#include <meeting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingServiceEvent *pEvent)=0
	Sets meeting service callback event handler.

virtual SDKError	HandleZoomWebUriProtocolAction (const zchar_t *protocol_action)=0
	Joins meeting with web uri.

virtual SDKError	Join (JoinParam &joinParam)=0
	Joins the meeting.

virtual SDKError	Start (StartParam &startParam)=0
	Starts meeting.

virtual SDKError	Leave (LeaveMeetingCmd leaveCmd)=0
	Leaves meeting.

virtual MeetingStatus	GetMeetingStatus ()=0
	Gets meeting status.

virtual SDKError	LockMeeting ()=0
	Lock the current meeting.

virtual SDKError	UnlockMeeting ()=0
	Unlock the current meeting.

virtual bool	IsMeetingLocked ()=0
	Determines if the meeting is locked.

virtual bool	CanSetMeetingTopic ()=0
	Determines if the current user can change the meeting topic.

virtual SDKError	SetMeetingTopic (const zchar_t *sTopic)=0
	Change the meeting topic.

virtual SDKError	SuspendParticipantsActivities ()=0
	Suspend all participant activities.

virtual bool	CanSuspendParticipantsActivities ()=0
	Determines if host/cohose can suspend participant activities.

virtual IMeetingInfo *	GetMeetingInfo ()=0
	Gets meeting information.

virtual ConnectionQuality	GetSharingConnQuality (bool bSending=true)=0
	Gets the quality of Internet connection when sharing.

virtual ConnectionQuality	GetVideoConnQuality (bool bSending=true)=0
	Gets the Internet connection quality of video.

virtual ConnectionQuality	GetAudioConnQuality (bool bSending=true)=0
	Gets the Internet connection quality of audio.

virtual SDKError	GetMeetingAudioStatisticInfo (MeetingAudioStatisticInfo &info)=0
	Gets meeting audio statistics information.

virtual SDKError	GetMeetingVideoStatisticInfo (MeetingASVStatisticInfo &info)=0
	Gets meeting video statistics information.

virtual SDKError	GetMeetingShareStatisticInfo (MeetingASVStatisticInfo &info)=0
	Gets meeting share statistics information.

virtual IMeetingVideoController *	GetMeetingVideoController ()=0
	Gets video controller interface.

virtual IMeetingShareController *	GetMeetingShareController ()=0
	Gets the sharing controller interface.

virtual IMeetingAudioController *	GetMeetingAudioController ()=0
	Gets the audio controller interface.

virtual IMeetingRecordingController *	GetMeetingRecordingController ()=0
	Gets the recording controller interface.

virtual IMeetingWaitingRoomController *	GetMeetingWaitingRoomController ()=0
	Gets the waiting room controller interface.

virtual IMeetingParticipantsController *	GetMeetingParticipantsController ()=0
	Gets the participants controller interface.

virtual IMeetingWebinarController *	GetMeetingWebinarController ()=0
	Gets the webinar controller interface.

virtual IMeetingRawArchivingController *	GetMeetingRawArchivingController ()=0
	Gets the Raw Archiving controller.

virtual IMeetingReminderController *	GetMeetingReminderController ()=0
	Gets the reminder controller.

virtual IMeetingSmartSummaryController *	GetMeetingSmartSummaryController ()=0
	Gets the smart summary controller.

virtual IMeetingChatController *	GetMeetingChatController ()=0
	Gets the chat controller interface.

virtual IMeetingBOController *	GetMeetingBOController ()=0
	Gets the Breakout Room controller.

virtual IMeetingConfiguration *	GetMeetingConfiguration ()=0
	Gets the meeting configuration interface.

virtual IMeetingAICompanionController *	GetMeetingAICompanionController ()=0
	Gets the AI companion controller.

virtual const zchar_t *	GetInMeetingDataCenterInfo ()=0
	Gets data center information.

virtual IMeetingEncryptionController *	GetInMeetingEncryptionController ()=0
	Gets the encryption controller.

virtual IListFactory *	GetListFactory ()=0
	Returns the list factory instance.

Detailed Description

Meeting Service Interface.

Definition at line 961 of file meeting_service_interface.h.

Member Function Documentation

◆ CanSetMeetingTopic()

virtual bool IMeetingService::CanSetMeetingTopic ( )

pure virtual

Determines if the current user can change the meeting topic.

Returns: If it can change the meeting topic, the return value is true.

◆ CanSuspendParticipantsActivities()

virtual bool IMeetingService::CanSuspendParticipantsActivities ( )

pure virtual

Determines if host/cohose can suspend participant activities.

Returns: If it can suspend participant activities, the return value is true.

◆ GetAudioConnQuality()

virtual ConnectionQuality IMeetingService::GetAudioConnQuality ( bool bSending = true )

pure virtual

Gets the Internet connection quality of audio.

Parameters

bSending true indicates to get the connection quality of sending the audio. false indicates to get the connection quality of receiving the audio.

Returns: If the function succeeds, it returns one of those enumerated in ConnectionQuality enum. Otherwise, this function fails and returns nullptr.

Note: If you are not in the meeting, the Conn_Quality_Unknown will be returned.

◆ GetInMeetingDataCenterInfo()

virtual const zchar_t * IMeetingService::GetInMeetingDataCenterInfo ( )

pure virtual

Gets data center information.

◆ GetInMeetingEncryptionController()

virtual IMeetingEncryptionController * IMeetingService::GetInMeetingEncryptionController ( )

pure virtual

Gets the encryption controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingEncryptionController. Otherwise returns nullptr.

◆ GetListFactory()

virtual IListFactory * IMeetingService::GetListFactory ( )

pure virtual

Returns the list factory instance.

Returns: IListFactory* A pointer to an IListFactory instance for handling list operations.Otherwise returns nullptr.

◆ GetMeetingAICompanionController()

virtual IMeetingAICompanionController * IMeetingService::GetMeetingAICompanionController ( )

pure virtual

Gets the AI companion controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingAICompanionController. Otherwise the function returns nullptr.

◆ GetMeetingAudioController()

virtual IMeetingAudioController * IMeetingService::GetMeetingAudioController ( )

pure virtual

Gets the audio controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingAudioController. Otherwise returns nullptr.

◆ GetMeetingAudioStatisticInfo()

virtual SDKError IMeetingService::GetMeetingAudioStatisticInfo ( MeetingAudioStatisticInfo & info )

pure virtual

Gets meeting audio statistics information.

Parameters

info_ [out] Audio statistics information.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetMeetingBOController()

virtual IMeetingBOController * IMeetingService::GetMeetingBOController ( )

pure virtual

Gets the Breakout Room controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingBOController. Otherwise returns nullptr.

◆ GetMeetingChatController()

virtual IMeetingChatController * IMeetingService::GetMeetingChatController ( )

pure virtual

Gets the chat controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingChatController. Otherwise returns nullptr.

◆ GetMeetingConfiguration()

virtual IMeetingConfiguration * IMeetingService::GetMeetingConfiguration ( )

pure virtual

Gets the meeting configuration interface.

Returns: If the function succeeds, the return value is the meeting configuration interface. Otherwise returns nullptr.

◆ GetMeetingInfo()

virtual IMeetingInfo * IMeetingService::GetMeetingInfo ( )

pure virtual

Gets meeting information.

Returns: If the function succeeds, the return value is the meeting information. Otherwise returns nullptr.

◆ GetMeetingParticipantsController()

virtual IMeetingParticipantsController * IMeetingService::GetMeetingParticipantsController ( )

pure virtual

Gets the participants controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingParticipantsController. Otherwise returns nullptr.

◆ GetMeetingRawArchivingController()

virtual IMeetingRawArchivingController * IMeetingService::GetMeetingRawArchivingController ( )

pure virtual

Gets the Raw Archiving controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingRawArchivingController. Otherwise returns nullptr.

◆ GetMeetingRecordingController()

virtual IMeetingRecordingController * IMeetingService::GetMeetingRecordingController ( )

pure virtual

Gets the recording controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingRecordingController. Otherwise returns nullptr.

◆ GetMeetingReminderController()

virtual IMeetingReminderController * IMeetingService::GetMeetingReminderController ( )

pure virtual

Gets the reminder controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingReminderController. Otherwise the function returns nullptr.

◆ GetMeetingShareController()

virtual IMeetingShareController * IMeetingService::GetMeetingShareController ( )

pure virtual

Gets the sharing controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingVideoController. Otherwise returns nullptr.

◆ GetMeetingShareStatisticInfo()

virtual SDKError IMeetingService::GetMeetingShareStatisticInfo ( MeetingASVStatisticInfo & info )

pure virtual

Gets meeting share statistics information.

Parameters

info_ [out] Share statistics information.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetMeetingSmartSummaryController()

virtual IMeetingSmartSummaryController * IMeetingService::GetMeetingSmartSummaryController ( )

pure virtual

Gets the smart summary controller.

Returns: If the function succeeds, the return value is a pointer to IMeetingSmartSummaryController. Otherwise the function returns nullptr.

Deprecated: This interface is marked as deprecated, and is replaced by GetMeetingSmartSummaryHelper() in class IMeetingAICompanionController.

◆ GetMeetingStatus()

virtual MeetingStatus IMeetingService::GetMeetingStatus ( )

pure virtual

Gets meeting status.

Returns: If the function succeeds, the return value is the current meeting status.

◆ GetMeetingVideoController()

virtual IMeetingVideoController * IMeetingService::GetMeetingVideoController ( )

pure virtual

Gets video controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingVideoController. Otherwise returns nullptr.

◆ GetMeetingVideoStatisticInfo()

virtual SDKError IMeetingService::GetMeetingVideoStatisticInfo ( MeetingASVStatisticInfo & info )

pure virtual

Gets meeting video statistics information.

Parameters

info_ [out] Video statistics information.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetMeetingWaitingRoomController()

virtual IMeetingWaitingRoomController * IMeetingService::GetMeetingWaitingRoomController ( )

pure virtual

Gets the waiting room controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingWaitingRoomController. Otherwise returns nullptr.

◆ GetMeetingWebinarController()

virtual IMeetingWebinarController * IMeetingService::GetMeetingWebinarController ( )

pure virtual

Gets the webinar controller interface.

Returns: If the function succeeds, the return value is a pointer to IMeetingWebinarController. Otherwise returns nullptr.

◆ GetSharingConnQuality()

virtual ConnectionQuality IMeetingService::GetSharingConnQuality ( bool bSending = true )

pure virtual

Gets the quality of Internet connection when sharing.

Parameters

bSending true indicates to get the connection quality of sending the sharing statistics. false indicates to get the connection quality of receiving the sharing statistics.

Returns: If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Note: If you are not in the meeting, the Conn_Quality_Unknown will be returned.

◆ GetVideoConnQuality()

virtual ConnectionQuality IMeetingService::GetVideoConnQuality ( bool bSending = true )

pure virtual

Gets the Internet connection quality of video.

Parameters

bSending true indicates to get the connection quality of sending the video. false indicates to get the connection quality of receiving the video.

Returns: If the function succeeds, the return is one of those enumerated in ConnectionQuality enum.

Note: If you are not in the meeting, the Conn_Quality_Unknown will be returned.

◆ HandleZoomWebUriProtocolAction()

virtual SDKError IMeetingService::HandleZoomWebUriProtocolAction ( const zchar_t * protocol_action )

pure virtual

Joins meeting with web uri.

Parameters

protocol_action Specifies the web uri

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsMeetingLocked()

virtual bool IMeetingService::IsMeetingLocked ( )

pure virtual

Determines if the meeting is locked.

Returns: true indicates the meeting status is locked.

◆ Join()

virtual SDKError IMeetingService::Join ( JoinParam & joinParam )

pure virtual

Joins the meeting.

Parameters

joinParam The parameter is used to join meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ Leave()

virtual SDKError IMeetingService::Leave ( LeaveMeetingCmd leaveCmd )

pure virtual

Leaves meeting.

Parameters

leaveCmd Leave meeting command.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ LockMeeting()

virtual SDKError IMeetingService::LockMeeting ( )

pure virtual

Lock the current meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetEvent()

virtual SDKError IMeetingService::SetEvent ( IMeetingServiceEvent * pEvent )

pure virtual

Sets meeting service callback event handler.

Parameters

pEvent A pointer to the IMeetingServiceEvent that receives the meeting service callback event.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetMeetingTopic()

virtual SDKError IMeetingService::SetMeetingTopic ( const zchar_t * sTopic )

pure virtual

Change the meeting topic.

Parameters

sTopic The new meeting topic.

Returns: If the function succeeds, the return value is the SDKERR_SUCCESS. Otherwise fails.

◆ Start()

virtual SDKError IMeetingService::Start ( StartParam & startParam )

pure virtual

Starts meeting.

Parameters

startParam The parameter is used to start meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SuspendParticipantsActivities()

virtual SDKError IMeetingService::SuspendParticipantsActivities ( )

pure virtual

Suspend all participant activities.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ UnlockMeeting()

virtual SDKError IMeetingService::UnlockMeeting ( )

pure virtual

Unlock the current meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanSetMeetingTopic()

◆ CanSuspendParticipantsActivities()

◆ GetAudioConnQuality()

◆ GetInMeetingDataCenterInfo()

◆ GetInMeetingEncryptionController()

◆ GetListFactory()

◆ GetMeetingAICompanionController()

◆ GetMeetingAudioController()

◆ GetMeetingAudioStatisticInfo()

◆ GetMeetingBOController()

◆ GetMeetingChatController()

◆ GetMeetingConfiguration()

◆ GetMeetingInfo()

◆ GetMeetingParticipantsController()

◆ GetMeetingRawArchivingController()

◆ GetMeetingRecordingController()

◆ GetMeetingReminderController()

◆ GetMeetingShareController()

◆ GetMeetingShareStatisticInfo()

◆ GetMeetingSmartSummaryController()

◆ GetMeetingStatus()

◆ GetMeetingVideoController()

◆ GetMeetingVideoStatisticInfo()

◆ GetMeetingWaitingRoomController()

◆ GetMeetingWebinarController()

◆ GetSharingConnQuality()

◆ GetVideoConnQuality()

◆ HandleZoomWebUriProtocolAction()

◆ IsMeetingLocked()

◆ Join()

◆ Leave()

◆ LockMeeting()

◆ SetEvent()

◆ SetMeetingTopic()

◆ Start()

◆ SuspendParticipantsActivities()

◆ UnlockMeeting()