IMeetingService Class Reference

Meeting Service Interface. More...

#include <meeting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingServiceEvent *pEvent)=0
	Set meeting service callback event handler.
virtual SDKError	HandleZoomWebUriProtocolAction (const zchar_t *protocol_action)=0
	Join meeting with web uri.
virtual SDKError	Join (JoinParam &joinParam)=0
	Join the meeting.
virtual SDKError	Start (StartParam &startParam)=0
	Start meeting.
virtual SDKError	Leave (LeaveMeetingCmd leaveCmd)=0
	Leave meeting.
virtual MeetingStatus	GetMeetingStatus ()=0
	Get meeting status.
virtual SDKError	LockMeeting ()=0
	Lock the current meeting.
virtual SDKError	UnlockMeeting ()=0
	Unlock the current meeting.
virtual bool	IsMeetingLocked ()=0
	Determine if the meeting is locked.
virtual bool	CanSetMeetingTopic ()=0
	Determine 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
	Determine if host/cohose can suspend participant activities.
virtual IMeetingInfo *	GetMeetingInfo ()=0
	Get meeting information.
virtual ConnectionQuality	GetSharingConnQuality (bool bSending=true)=0
	Get the quality of Internet connection when sharing.
virtual ConnectionQuality	GetVideoConnQuality (bool bSending=true)=0
	Get the Internet connection quality of video.
virtual ConnectionQuality	GetAudioConnQuality (bool bSending=true)=0
	Get the Internet connection quality of audio.
virtual IMeetingVideoController *	GetMeetingVideoController ()=0
	Get video controller interface.
virtual IMeetingShareController *	GetMeetingShareController ()=0
	Get the sharing controller interface.
virtual IMeetingAudioController *	GetMeetingAudioController ()=0
	Get the audio controller interface.
virtual IMeetingRecordingController *	GetMeetingRecordingController ()=0
	Get the recording controller interface.
virtual IMeetingWaitingRoomController *	GetMeetingWaitingRoomController ()=0
	Get the waiting room controller interface.
virtual IMeetingParticipantsController *	GetMeetingParticipantsController ()=0
	Get the participants controller interface.
virtual IMeetingWebinarController *	GetMeetingWebinarController ()=0
	Get the webinar controller interface.
virtual IMeetingRawArchivingController *	GetMeetingRawArchivingController ()=0
	Get the Raw Archiving controller.
virtual IMeetingReminderController *	GetMeetingReminderController ()=0
	Get the reminder controller.
virtual IMeetingSmartSummaryController *	GetMeetingSmartSummaryController ()=0
	Get the smart summary controller.
virtual IMeetingChatController *	GetMeetingChatController ()=0
	Get the chat controller interface.
virtual IMeetingBOController *	GetMeetingBOController ()=0
	Get the Breakout Room controller.
virtual IMeetingConfiguration *	GetMeetingConfiguration ()=0
	Get the meeting configuration interface.
virtual IMeetingAICompanionController *	GetMeetingAICompanionController ()=0
	Get the AI companion controller.
virtual IMeetingUIController *	GetUIController ()=0
	Get the meeting UI controller interface.
virtual IAnnotationController *	GetAnnotationController ()=0
	Get the annotation controller interface.
virtual IMeetingRemoteController *	GetMeetingRemoteController ()=0
	Get the remote controller interface.
virtual IMeetingH323Helper *	GetH323Helper ()=0
	Get the meeting H.323 helper interface.
virtual IMeetingPhoneHelper *	GetMeetingPhoneHelper ()=0
	Get the meeting phone helper interface.
virtual IMeetingLiveStreamController *	GetMeetingLiveStreamController ()=0
	Get the live stream controller interface.
virtual IClosedCaptionController *	GetMeetingClosedCaptionController ()=0
	Get the Closed Caption controller interface.
virtual IZoomRealNameAuthMeetingHelper *	GetMeetingRealNameAuthController ()=0
	Get the real name auth controller interface.
virtual IMeetingQAController *	GetMeetingQAController ()=0
	Get the Q&A controller.
virtual IMeetingInterpretationController *	GetMeetingInterpretationController ()=0
	Get the Interpretation controller.
virtual IMeetingSignInterpretationController *	GetMeetingSignInterpretationController ()=0
	Get the sign interpretation controller.
virtual IEmojiReactionController *	GetMeetingEmojiReactionController ()=0
	Get the Reaction controller.
virtual IMeetingAANController *	GetMeetingAANController ()=0
	Get the AAN controller.
virtual ICustomImmersiveController *	GetMeetingImmersiveController ()=0
	Get the immersive controller.
virtual IMeetingWhiteboardController *	GetMeetingWhiteboardController ()=0
	Get the Whiteboard controller.
virtual IMeetingDocsController *	GetMeetingDocsController ()=0
	Get the Docs controller.
virtual IMeetingPollingController *	GetMeetingPollingController ()=0
	Get the Polling controller.
virtual IMeetingRemoteSupportController *	GetMeetingRemoteSupportController ()=0
	Get the remote support controller.
virtual IMeetingIndicatorController *	GetMeetingIndicatorController ()=0
	Get the Indicator controller.
virtual IMeetingProductionStudioController *	GetMeetingProductionStudioController ()=0
	Get the production studio controller.
virtual const zchar_t *	GetInMeetingDataCenterInfo ()=0
	Get data center information.
virtual IMeetingEncryptionController *	GetInMeetingEncryptionController ()=0
	Get the encryption controller.

Detailed Description

Meeting Service Interface.

Definition at line 535 of file meeting_service_interface.h.

Member Function Documentation

CanSetMeetingTopic()

virtual bool IMeetingService::CanSetMeetingTopic ( )

pure virtual

Determine 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

Determine if host/cohose can suspend participant activities.

Returns

If it can suspend participant activities, the return value is True.

GetAnnotationController()

virtual IAnnotationController * IMeetingService::GetAnnotationController ( )

pure virtual

Get the annotation controller interface.

Returns

If the function succeeds, the return value is a pointer of IAnnotationController. Otherwise returns nullptr.

GetAudioConnQuality()

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

pure virtual

Get 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, the return value is one of those enumerated in ConnectionQuality enum.

Remarks

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

GetH323Helper()

virtual IMeetingH323Helper * IMeetingService::GetH323Helper ( )

pure virtual

Get the meeting H.323 helper interface.

Returns

If the function succeeds, the return value is a pointer to IMeetingH323Helper. Otherwise returns nullptr.

GetInMeetingDataCenterInfo()

virtual const zchar_t * IMeetingService::GetInMeetingDataCenterInfo ( )

pure virtual

Get data center information.

GetInMeetingEncryptionController()

virtual IMeetingEncryptionController * IMeetingService::GetInMeetingEncryptionController ( )

pure virtual

Get the encryption controller.

Returns

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

GetMeetingAANController()

virtual IMeetingAANController * IMeetingService::GetMeetingAANController ( )

pure virtual

Get the AAN controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingAANController. Otherwise returns nullptr.

GetMeetingAICompanionController()

virtual IMeetingAICompanionController * IMeetingService::GetMeetingAICompanionController ( )

pure virtual

Get 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

Get the audio controller interface.

Returns

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

GetMeetingBOController()

virtual IMeetingBOController * IMeetingService::GetMeetingBOController ( )

pure virtual

Get 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

Get the chat controller interface.

Returns

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

GetMeetingClosedCaptionController()

virtual IClosedCaptionController * IMeetingService::GetMeetingClosedCaptionController ( )

pure virtual

Get the Closed Caption controller interface.

Returns

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

GetMeetingConfiguration()

virtual IMeetingConfiguration * IMeetingService::GetMeetingConfiguration ( )

pure virtual

Get the meeting configuration interface.

Returns

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

GetMeetingDocsController()

virtual IMeetingDocsController * IMeetingService::GetMeetingDocsController ( )

pure virtual

Get the Docs controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingDocsController. Otherwise the function returns nullptr.

GetMeetingEmojiReactionController()

virtual IEmojiReactionController * IMeetingService::GetMeetingEmojiReactionController ( )

pure virtual

Get the Reaction controller.

Returns

If the function succeeds, the return value is a pointer to IEmojiReactionController. Otherwise returns nullptr.

GetMeetingImmersiveController()

virtual ICustomImmersiveController * IMeetingService::GetMeetingImmersiveController ( )

pure virtual

Get the immersive controller.

Returns

If the function succeeds, the return value is a pointer to ICustomImmersiveController. Otherwise the function returns nullptr.

GetMeetingIndicatorController()

virtual IMeetingIndicatorController * IMeetingService::GetMeetingIndicatorController ( )

pure virtual

Get the Indicator controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingIndicatorController. Otherwise the function returns nullptr.

GetMeetingInfo()

virtual IMeetingInfo * IMeetingService::GetMeetingInfo ( )

pure virtual

Get meeting information.

Returns

If the function succeeds, the return value is the meeting information. Otherwise returns nullptr. For more details, see IMeetingInfo.

GetMeetingInterpretationController()

virtual IMeetingInterpretationController * IMeetingService::GetMeetingInterpretationController ( )

pure virtual

Get the Interpretation controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingInterpretationController. Otherwise returns nullptr.

GetMeetingLiveStreamController()

virtual IMeetingLiveStreamController * IMeetingService::GetMeetingLiveStreamController ( )

pure virtual

Get the live stream controller interface.

Returns

If the function succeeds, the return value is a pointer to IMeetingLiveStreamController. Otherwise returns nullptr.

GetMeetingParticipantsController()

virtual IMeetingParticipantsController * IMeetingService::GetMeetingParticipantsController ( )

pure virtual

Get the participants controller interface.

Returns

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

GetMeetingPhoneHelper()

virtual IMeetingPhoneHelper * IMeetingService::GetMeetingPhoneHelper ( )

pure virtual

Get the meeting phone helper interface.

Returns

If the function succeeds, the return value is a pointer of IMeetingPhoneHelper. Otherwise returns nullptr.

GetMeetingPollingController()

virtual IMeetingPollingController * IMeetingService::GetMeetingPollingController ( )

pure virtual

Get the Polling controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingPollingController. Otherwise the function returns nullptr.

GetMeetingProductionStudioController()

virtual IMeetingProductionStudioController * IMeetingService::GetMeetingProductionStudioController ( )

pure virtual

Get the production studio controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingProductionStudioController. Otherwise returns nullptr.

GetMeetingQAController()

virtual IMeetingQAController * IMeetingService::GetMeetingQAController ( )

pure virtual

Get the Q&A controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingQAController. Otherwise returns nullptr.

GetMeetingRawArchivingController()

virtual IMeetingRawArchivingController * IMeetingService::GetMeetingRawArchivingController ( )

pure virtual

Get the Raw Archiving controller.

Returns

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

GetMeetingRealNameAuthController()

virtual IZoomRealNameAuthMeetingHelper * IMeetingService::GetMeetingRealNameAuthController ( )

pure virtual

Get the real name auth controller interface.

Returns

If the function succeeds, the return value is a pointer to IZoomRealNameAuthMeetingHelper. Otherwise returns nullptr.

GetMeetingRecordingController()

virtual IMeetingRecordingController * IMeetingService::GetMeetingRecordingController ( )

pure virtual

Get 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

Get the reminder controller.

Returns

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

GetMeetingRemoteController()

virtual IMeetingRemoteController * IMeetingService::GetMeetingRemoteController ( )

pure virtual

Get the remote controller interface.

Returns

If the function succeeds, the return value is a pointer of IMeetingVideoController. Otherwise returns nullptr.

GetMeetingRemoteSupportController()

virtual IMeetingRemoteSupportController * IMeetingService::GetMeetingRemoteSupportController ( )

pure virtual

Get the remote support controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingRemoteSupportController. Otherwise the function returns nullptr.

GetMeetingShareController()

virtual IMeetingShareController * IMeetingService::GetMeetingShareController ( )

pure virtual

Get the sharing controller interface.

Returns

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

GetMeetingSignInterpretationController()

virtual IMeetingSignInterpretationController * IMeetingService::GetMeetingSignInterpretationController ( )

pure virtual

Get the sign interpretation controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingSignInterpretationController. Otherwise returns nullptr.

GetMeetingSmartSummaryController()

virtual IMeetingSmartSummaryController * IMeetingService::GetMeetingSmartSummaryController ( )

pure virtual

Get 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

Get meeting status.

Returns

If the function succeeds, the return value is the current meeting status. Otherwise failed. To get extended error information, see MeetingStatus enum.

GetMeetingVideoController()

virtual IMeetingVideoController * IMeetingService::GetMeetingVideoController ( )

pure virtual

Get video controller interface.

Returns

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

GetMeetingWaitingRoomController()

virtual IMeetingWaitingRoomController * IMeetingService::GetMeetingWaitingRoomController ( )

pure virtual

Get 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

Get the webinar controller interface.

Returns

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

GetMeetingWhiteboardController()

virtual IMeetingWhiteboardController * IMeetingService::GetMeetingWhiteboardController ( )

pure virtual

Get the Whiteboard controller.

Returns

If the function succeeds, the return value is a pointer to IMeetingWhiteboardController. Otherwise the function returns nullptr.

GetSharingConnQuality()

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

pure virtual

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

Remarks

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

GetUIController()

virtual IMeetingUIController * IMeetingService::GetUIController ( )

pure virtual

Get the meeting UI controller interface.

Returns

If the function succeeds, the return value is a pointer to the IMeetingConfiguration. Otherwise returns nullptr.

GetVideoConnQuality()

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

pure virtual

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

Remarks

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

Join meeting with web uri.

Parameters

protocol_action

Specifies the web uri

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

IsMeetingLocked()

virtual bool IMeetingService::IsMeetingLocked ( )

pure virtual

Determine if the meeting is locked.

Returns

TRUE indicates the meeting status is locked.

Join()

virtual SDKError IMeetingService::Join ( JoinParam & joinParam )

pure virtual

Join the meeting.

Parameters

joinParam

The parameter is used to join meeting. For more details, see JoinParam structure.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Leave()

virtual SDKError IMeetingService::Leave ( LeaveMeetingCmd leaveCmd )

pure virtual

Leave meeting.

Parameters

leaveCmd

Leave meeting command. For more details, see LeaveMeetingCmd enum.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

LockMeeting()

virtual SDKError IMeetingService::LockMeeting ( )

pure virtual

Lock the current meeting.

Returns

If the function succeeds, the return value is the SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SetEvent()

virtual SDKError IMeetingService::SetEvent ( IMeetingServiceEvent * pEvent )

pure virtual

Set 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 failed. To get extended error information, see SDKError enum.

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. To get extended error information, see SDKError enum.

Start()

virtual SDKError IMeetingService::Start ( StartParam & startParam )

pure virtual

Start meeting.

Parameters

startParam

The parameter is used to start meeting. For more details, see StartParam structure.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

SuspendParticipantsActivities()

virtual SDKError IMeetingService::SuspendParticipantsActivities ( )

pure virtual

Suspend all participant activities.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

UnlockMeeting()

virtual SDKError IMeetingService::UnlockMeeting ( )

pure virtual

Unlock the current meeting.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.