Meeting Service Interface. More...

#include <meeting_service_interface.h>

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

virtual SDKError	HandleZoomWebUriProtocolAction (const wchar_t *protocol_action)=0
	Join meeting with web uri. More...

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

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

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

virtual MeetingStatus	GetMeetingStatus ()=0
	Get meeting status. More...

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

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

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

virtual IMeetingInfo *	GetMeetingInfo ()=0
	Get meeting information. More...

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

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

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

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

virtual IMeetingUIController *	GetUIController ()=0
	Get the meeting UI controller interface. More...

virtual IAnnotationController *	GetAnnotationController ()=0
	Get the annotation controller interface. More...

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

virtual IMeetingRemoteController *	GetMeetingRemoteController ()=0
	Get the remote controller interface. More...

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

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

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

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

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

virtual IMeetingH323Helper *	GetH323Helper ()=0
	Get the meeting H.323 helper interface. More...

virtual IMeetingPhoneHelper *	GetMeetingPhoneHelper ()=0
	Get the meeting phone helper interface. More...

virtual IMeetingBreakoutRoomsController *	GetMeetingBreakoutRoomsController ()=0
	Get the breakout rooms controller interface. More...

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

virtual IMeetingLiveStreamController *	GetMeetingLiveStreamController ()=0
	Get the live stream controller interface. More...

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

virtual IClosedCaptionController *	GetMeetingClosedCaptionController ()=0
	Get the Closed Caption controller interface. More...

virtual IZoomRealNameAuthMeetingHelper *	GetMeetingRealNameAuthController ()=0
	Get the real name auth controller interface. More...

virtual IMeetingQAController *	GetMeetingQAController ()=0
	Get the Q&A controller. More...

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

virtual IMeetingInterpretationController *	GetMeetingInterpretationController ()=0
	Get the Interpretation controller. More...

Detailed Description

Meeting Service Interface.

Member Function Documentation

◆ 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 NULL.

◆ 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_Unknow 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ GetMeetingBreakoutRoomsController()

virtual IMeetingBreakoutRoomsController* IMeetingService::GetMeetingBreakoutRoomsController ( )

pure virtual

Get the breakout rooms controller interface.

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

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ GetMeetingInfo()

virtual IMeetingInfo* IMeetingService::GetMeetingInfo ( )

pure virtual

Get meeting information.

Returns: If the function succeeds, the return value is the meeting information. Otherwise returns NULL. 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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 NULL.

◆ 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_Unknow 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 NULL.

◆ 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_Unknow will be returned.

◆ HandleZoomWebUriProtocolAction()

virtual SDKError IMeetingService::HandleZoomWebUriProtocolAction ( const wchar_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.

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

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

The documentation for this class was generated from the following file:

h/meeting_service_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAnnotationController()

◆ GetAudioConnQuality()

◆ GetH323Helper()

◆ GetMeetingAudioController()

◆ GetMeetingBOController()

◆ GetMeetingBreakoutRoomsController()

◆ GetMeetingChatController()

◆ GetMeetingClosedCaptionController()

◆ GetMeetingConfiguration()

◆ GetMeetingInfo()

◆ GetMeetingInterpretationController()

◆ GetMeetingLiveStreamController()

◆ GetMeetingParticipantsController()

◆ GetMeetingPhoneHelper()

◆ GetMeetingQAController()

◆ GetMeetingRealNameAuthController()

◆ GetMeetingRecordingController()

◆ GetMeetingRemoteController()

◆ GetMeetingShareController()

◆ GetMeetingStatus()

◆ GetMeetingVideoController()

◆ GetMeetingWaitingRoomController()

◆ GetMeetingWebinarController()

◆ GetSharingConnQuality()

◆ GetUIController()

◆ GetVideoConnQuality()

◆ HandleZoomWebUriProtocolAction()

◆ IsMeetingLocked()

◆ Join()

◆ Leave()

◆ LockMeeting()

◆ SetEvent()

◆ Start()

◆ UnlockMeeting()