Meeting Service Interface. More...

#include <IMeetingService.h>

Public Member Functions
virtual	~IMeetingService ()

virtual ZRCSDKError	RegisterSink (IMeetingServiceSink *pSink)=0
	Register meeting service callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingServiceSink *pSink)=0
	Deregister meeting service callback sink.

virtual ZRCSDKError	StartInstantMeeting ()=0
	Start an instant meeting.

virtual ZRCSDKError	MeetWithIMUsers (const std::vector< std::string > &contactIDs)=0
	Start an instant meeting and invite the selected IM users.

virtual ZRCSDKError	StartMeeting (const MeetingItem &meeting, bool bringShareToMeeting=false)=0
	Start the selected meeting from meeting list.

virtual ZRCSDKError	StartMeetingWithHostKey (const std::string &hostKey)=0
	Use host key to start the meeting.

virtual ZRCSDKError	JoinMeeting (const std::string &meetingNumber, bool bringShareToMeeting=false)=0
	Join the meeting by meeting number.

virtual ZRCSDKError	JoinMeetingWithURL (const std::string &url, bool bringShareToMeeting=false)=0
	Join the meeting by url.

virtual ZRCSDKError	JoinMeetingWithContactID (const std::string &contactID, bool bringShareToMeeting=false)=0
	Join a personal room meeting with contact ID.

virtual ZRCSDKError	ExitMeeting (ExitMeetingCmd exitCmd)=0
	Exit meeting.

virtual ZRCSDKError	SetRoomTempDisplayNameForMeeting (const std::string &roomTempName)=0
	Set room's temp display name for the meeting.

virtual ZRCSDKError	SendMeetingPassword (const std::string &password)=0
	Enter the meeting password to join meeting.

virtual ZRCSDKError	CancelEnteringMeetingPassword ()=0
	Cancel entering meeting password, cancel joining the meeting.

virtual ZRCSDKError	CancelWaitingForHost ()=0
	Cancel waiting for host, cancel joining the meeting.

virtual ZRCSDKError	AnswerMeetingInvite (const MeetingInvitationInfo &invite, bool accept)=0
	Answer the meeting invite.

virtual ZRCSDKError	InviteAttendees (const std::vector< std::string > &contactIDs)=0
	Invited attendees into meeting.

virtual ZRCSDKError	InviteLegacyRoomSystems (const std::vector< LegacyRoomSystem > &roomSystems)=0
	Invite legacy room system into meeting.

virtual ZRCSDKError	InviteLegacyRoomSystemWithIpOrE164Number (const std::string &ipOrE164Number, RoomSystemProtocolType protocolType, bool cancel)=0
	Invited legacy room system into meeting.

virtual ZRCSDKError	SendMeetingInviteEmail (const std::string &recipients)=0
	Send meeting invite email to recipients.

virtual ZRCSDKError	RequestE2ESecurityCode ()=0
	Request end-to-end security code.

virtual ZRCSDKError	SendDTMF (const std::string &digitKey, int32_t userID)=0
	Send DTMF when dialing.

virtual ZRCSDKError	GetMeetingStatus (MeetingStatus &status)=0
	Get meeting status.

virtual ZRCSDKError	GetMeetingInfo (MeetingInfo &info)=0
	Get meeting information.

virtual ZRCSDKError	ExtendMeeting ()=0
	Extend zoom meeting scheduled with automatically stop.

virtual IMeetingListHelper *	GetMeetingListHelper ()=0
	Get the meeting list helper interface.

virtual IThirdPartyMeetingHelper *	GetThirdPartyMeetingHelper ()=0
	Get the third party meeting helper.

virtual IMeetingReminderHelper *	GetMeetingReminderHelper ()=0
	Get the meeting reminder helper.

virtual IWaitingRoomHelper *	GetWaitingRoomHelper ()=0
	Get the waiting room helper.

virtual IMeetingAudioHelper *	GetMeetingAudioHelper ()=0
	Get the meeting audio helper.

virtual IMeetingVideoHelper *	GetMeetingVideoHelper ()=0
	Get the meeting video helper.

virtual IMeetingShareHelper *	GetMeetingShareHelper ()=0
	Get the meeting share helper.

virtual IRecordingHelper *	GetRecordingHelper ()=0
	Get the recording helper.

virtual IMeetingViewLayoutHelper *	GetMeetingViewLayoutHelper ()=0
	Get the meeting view layout helper.

virtual ICameraControlHelper *	GetCameraControlHelper ()=0
	Get the camera control helper.

virtual IClosedCaptionHelper *	GetClosedCaptionHelper ()=0
	Get the closed caption helper.

virtual IMeetingControlHelper *	GetMeetingControlHelper ()=0
	Get the meeting control helper.

virtual IParticipantHelper *	GetParticipantHelper ()=0
	Get the participant helper.

virtual IBreakoutRoomHelper *	GetBreakoutRoomHelper ()=0
	Get the breakout room helper.

virtual IMeetingReactionEmojiHelper *	GetMeetingReactionEmojiHelper ()=0
	Get the meeting reaction emoji helper.

virtual IMeetingChatHelper *	GetMeetingChatHelper ()=0
	Get the meeting chat helper.

virtual INDIHelper *	GetNDIHelper ()=0
	Get the NDI helper.

virtual IMeetingWebinarHelper *	GetMeetingWebinarHelper ()=0
	Get the meeting webinar helper.

virtual IVirtualBackgroundHelper *	GetVirtualBackgroundHelper ()=0
	Get the virtual background helper.

virtual IMeetingPollingHelper *	GetMeetingPollingHelper ()=0
	Get the meeting polling helper.

virtual IMeetingQAHelper *	GetMeetingQAHelper ()=0
	Get the meeting Q&A helper.

virtual IWebinarBreakoutRoomHelper *	GetWebinarBreakoutRoomHelper ()=0
	Get the webinar breakout room helper.

virtual ICloudWhiteboardHelper *	GetCloudWhiteboardHelper ()=0
	Get the cloud whiteboard helper.

virtual ISmartTagHelper *	GetSmartTagHelper ()=0
	Get the smart tag helper.

Detailed Description

Meeting Service Interface.

Definition at line 421 of file IMeetingService.h.

Constructor & Destructor Documentation

◆ ~IMeetingService()

virtual IMeetingService::~IMeetingService ( )

inlinevirtual

Definition at line 424 of file IMeetingService.h.

424{}

Member Function Documentation

◆ AnswerMeetingInvite()

virtual ZRCSDKError IMeetingService::AnswerMeetingInvite	(	const MeetingInvitationInfo &	invite,
		bool	accept
	)

pure virtual

Answer the meeting invite.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

invite	The meeting invite.
accept	TRUE indicates to accept the meeting invite. Otherwise decline.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CancelEnteringMeetingPassword()

virtual ZRCSDKError IMeetingService::CancelEnteringMeetingPassword ( )

pure virtual

Cancel entering meeting password, cancel joining the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CancelWaitingForHost()

virtual ZRCSDKError IMeetingService::CancelWaitingForHost ( )

pure virtual

Cancel waiting for host, cancel joining the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingService::DeregisterSink ( IMeetingServiceSink * pSink )

pure virtual

Deregister meeting service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingServiceSink that receives the meeting service callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ExitMeeting()

virtual ZRCSDKError IMeetingService::ExitMeeting ( ExitMeetingCmd exitCmd )

pure virtual

Exit meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

exitCmd Exit meeting command. For more details, see ExitMeetingCmd enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ExtendMeeting()

virtual ZRCSDKError IMeetingService::ExtendMeeting ( )

pure virtual

Extend zoom meeting scheduled with automatically stop.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetBreakoutRoomHelper()

virtual IBreakoutRoomHelper * IMeetingService::GetBreakoutRoomHelper ( )

pure virtual

Get the breakout room helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetCameraControlHelper()

virtual ICameraControlHelper * IMeetingService::GetCameraControlHelper ( )

pure virtual

Get the camera control helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetClosedCaptionHelper()

virtual IClosedCaptionHelper * IMeetingService::GetClosedCaptionHelper ( )

pure virtual

Get the closed caption helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetCloudWhiteboardHelper()

virtual ICloudWhiteboardHelper * IMeetingService::GetCloudWhiteboardHelper ( )

pure virtual

Get the cloud whiteboard helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ GetMeetingAudioHelper()

virtual IMeetingAudioHelper * IMeetingService::GetMeetingAudioHelper ( )

pure virtual

Get the meeting audio helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingChatHelper()

virtual IMeetingChatHelper * IMeetingService::GetMeetingChatHelper ( )

pure virtual

Get the meeting chat helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingControlHelper()

virtual IMeetingControlHelper * IMeetingService::GetMeetingControlHelper ( )

pure virtual

Get the meeting control helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingInfo()

virtual ZRCSDKError IMeetingService::GetMeetingInfo ( MeetingInfo & info )

pure virtual

Get meeting information.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] info Current meeting info.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetMeetingListHelper()

virtual IMeetingListHelper * IMeetingService::GetMeetingListHelper ( )

pure virtual

Get the meeting list helper interface.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingPollingHelper()

virtual IMeetingPollingHelper * IMeetingService::GetMeetingPollingHelper ( )

pure virtual

Get the meeting polling helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ GetMeetingQAHelper()

virtual IMeetingQAHelper * IMeetingService::GetMeetingQAHelper ( )

pure virtual

Get the meeting Q&A helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ GetMeetingReactionEmojiHelper()

virtual IMeetingReactionEmojiHelper * IMeetingService::GetMeetingReactionEmojiHelper ( )

pure virtual

Get the meeting reaction emoji helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingReminderHelper()

virtual IMeetingReminderHelper * IMeetingService::GetMeetingReminderHelper ( )

pure virtual

Get the meeting reminder helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingShareHelper()

virtual IMeetingShareHelper * IMeetingService::GetMeetingShareHelper ( )

pure virtual

Get the meeting share helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingStatus()

virtual ZRCSDKError IMeetingService::GetMeetingStatus ( MeetingStatus & status )

pure virtual

Get meeting status.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] status Current meeting status.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetMeetingVideoHelper()

virtual IMeetingVideoHelper * IMeetingService::GetMeetingVideoHelper ( )

pure virtual

Get the meeting video helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingViewLayoutHelper()

virtual IMeetingViewLayoutHelper * IMeetingService::GetMeetingViewLayoutHelper ( )

pure virtual

Get the meeting view layout helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetMeetingWebinarHelper()

virtual IMeetingWebinarHelper * IMeetingService::GetMeetingWebinarHelper ( )

pure virtual

Get the meeting webinar helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetNDIHelper()

virtual INDIHelper * IMeetingService::GetNDIHelper ( )

pure virtual

Get the NDI helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetParticipantHelper()

virtual IParticipantHelper * IMeetingService::GetParticipantHelper ( )

pure virtual

Get the participant helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetRecordingHelper()

virtual IRecordingHelper * IMeetingService::GetRecordingHelper ( )

pure virtual

Get the recording helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetSmartTagHelper()

virtual ISmartTagHelper * IMeetingService::GetSmartTagHelper ( )

pure virtual

Get the smart tag helper.

Since: 6.3.5

Zoom Rooms minimum version: 6.2.0

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

◆ GetThirdPartyMeetingHelper()

virtual IThirdPartyMeetingHelper * IMeetingService::GetThirdPartyMeetingHelper ( )

pure virtual

Get the third party meeting helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetVirtualBackgroundHelper()

virtual IVirtualBackgroundHelper * IMeetingService::GetVirtualBackgroundHelper ( )

pure virtual

Get the virtual background helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetWaitingRoomHelper()

virtual IWaitingRoomHelper * IMeetingService::GetWaitingRoomHelper ( )

pure virtual

Get the waiting room helper.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ GetWebinarBreakoutRoomHelper()

virtual IWebinarBreakoutRoomHelper * IMeetingService::GetWebinarBreakoutRoomHelper ( )

pure virtual

Get the webinar breakout room helper.

Since: 6.3.5

Zoom Rooms minimum version: 6.3.0

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

◆ InviteAttendees()

virtual ZRCSDKError IMeetingService::InviteAttendees ( const std::vector< std::string > & contactIDs )

pure virtual

Invited attendees into meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This API must be called from a meeting.

Parameters

contactIDs Invited attendees' contact IDs.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ InviteLegacyRoomSystems()

virtual ZRCSDKError IMeetingService::InviteLegacyRoomSystems ( const std::vector< LegacyRoomSystem > & roomSystems )

pure virtual

Invite legacy room system into meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

roomSystems The room system list.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ InviteLegacyRoomSystemWithIpOrE164Number()

virtual ZRCSDKError IMeetingService::InviteLegacyRoomSystemWithIpOrE164Number	(	const std::string &	ipOrE164Number,
		RoomSystemProtocolType	protocolType,
		bool	cancel
	)

pure virtual

Invited legacy room system into meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This API must be called in a meeting.

Parameters

ipOrE164Number	Specify the ip or e164 number to invite.
protocolType	Protocol type, see RoomSystemProtocolType enum.
cancel	TRUE indicates to cancel invite.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ JoinMeeting()

virtual ZRCSDKError IMeetingService::JoinMeeting	(	const std::string &	meetingNumber,
		bool	bringShareToMeeting = `false`
	)

pure virtual

Join the meeting by meeting number.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

From 6.0.0: meeting number supports both meeting number and personal link.

meeting number: numeric meeting number, for example 123456789.
personal link: if your personal link is configured as https://zoom.us/my/your.personallink, use "your.personallink".

Parameters

meetingNumber	Meeting number of the meeting.
bringShareToMeeting	TRUE indicates brings current local share to meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ JoinMeetingWithContactID()

virtual ZRCSDKError IMeetingService::JoinMeetingWithContactID	(	const std::string &	contactID,
		bool	bringShareToMeeting = `false`
	)

pure virtual

Join a personal room meeting with contact ID.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

contactID	Contact ID who owns the personal room.
bringShareToMeeting	TRUE indicates brings current local share to meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ JoinMeetingWithURL()

virtual ZRCSDKError IMeetingService::JoinMeetingWithURL	(	const std::string &	url,
		bool	bringShareToMeeting = `false`
	)

pure virtual

Join the meeting by url.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

From 6.0.0: url supports Contact.location

Parameters

url	Join meeting url.
bringShareToMeeting	TRUE indicates brings current local share to meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MeetWithIMUsers()

virtual ZRCSDKError IMeetingService::MeetWithIMUsers ( const std::vector< std::string > & contactIDs )

pure virtual

Start an instant meeting and invite the selected IM users.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

contactIDs IM users' contact ID list.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingService::RegisterSink ( IMeetingServiceSink * pSink )

pure virtual

Register meeting service callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingServiceSink that receives the meeting service callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RequestE2ESecurityCode()

virtual ZRCSDKError IMeetingService::RequestE2ESecurityCode ( )

pure virtual

Request end-to-end security code.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

This API must be called in a end-to-end encrypted meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SendDTMF()

virtual ZRCSDKError IMeetingService::SendDTMF	(	const std::string &	digitKey,
		int32_t	userID
	)

pure virtual

Send DTMF when dialing.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

digitKey	The dial digit key
userID	The specified participant user ID or room system user ID. [0] for PSTN call.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SendMeetingInviteEmail()

virtual ZRCSDKError IMeetingService::SendMeetingInviteEmail ( const std::string & recipients )

pure virtual

Send meeting invite email to recipients.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

recipients The recipients email, spilt with ';'. For example, perso.nosp@m.n1@t.nosp@m.est.c.nosp@m.om;perso.nosp@m.n2@t.nosp@m.est.c.nosp@m.om

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SendMeetingPassword()

virtual ZRCSDKError IMeetingService::SendMeetingPassword ( const std::string & password )

pure virtual

Enter the meeting password to join meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

password Meeting password.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetRoomTempDisplayNameForMeeting()

virtual ZRCSDKError IMeetingService::SetRoomTempDisplayNameForMeeting ( const std::string & roomTempName )

pure virtual

Set room's temp display name for the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

roomTempName Room's temp display name. Empty string indicates to skip the action.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartInstantMeeting()

virtual ZRCSDKError IMeetingService::StartInstantMeeting ( )

pure virtual

Start an instant meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartMeeting()

virtual ZRCSDKError IMeetingService::StartMeeting	(	const MeetingItem &	meeting,
		bool	bringShareToMeeting = `false`
	)

pure virtual

Start the selected meeting from meeting list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meeting	The selected meeting item to be started.
bringShareToMeeting	TRUE indicates brings current local share to meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ StartMeetingWithHostKey()

virtual ZRCSDKError IMeetingService::StartMeetingWithHostKey ( const std::string & hostKey )

pure virtual

Use host key to start the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

hostKey Host key of the current meeting.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingService()

Member Function Documentation

◆ AnswerMeetingInvite()

◆ CancelEnteringMeetingPassword()

◆ CancelWaitingForHost()

◆ DeregisterSink()

◆ ExitMeeting()

◆ ExtendMeeting()

◆ GetBreakoutRoomHelper()

◆ GetCameraControlHelper()

◆ GetClosedCaptionHelper()

◆ GetCloudWhiteboardHelper()

◆ GetMeetingAudioHelper()

◆ GetMeetingChatHelper()

◆ GetMeetingControlHelper()

◆ GetMeetingInfo()

◆ GetMeetingListHelper()

◆ GetMeetingPollingHelper()

◆ GetMeetingQAHelper()

◆ GetMeetingReactionEmojiHelper()

◆ GetMeetingReminderHelper()

◆ GetMeetingShareHelper()

◆ GetMeetingStatus()

◆ GetMeetingVideoHelper()

◆ GetMeetingViewLayoutHelper()

◆ GetMeetingWebinarHelper()

◆ GetNDIHelper()

◆ GetParticipantHelper()

◆ GetRecordingHelper()

◆ GetSmartTagHelper()

◆ GetThirdPartyMeetingHelper()

◆ GetVirtualBackgroundHelper()

◆ GetWaitingRoomHelper()

◆ GetWebinarBreakoutRoomHelper()

◆ InviteAttendees()

◆ InviteLegacyRoomSystems()

◆ InviteLegacyRoomSystemWithIpOrE164Number()

◆ JoinMeeting()

◆ JoinMeetingWithContactID()

◆ JoinMeetingWithURL()

◆ MeetWithIMUsers()

◆ RegisterSink()

◆ RequestE2ESecurityCode()

◆ SendDTMF()

◆ SendMeetingInviteEmail()

◆ SendMeetingPassword()

◆ SetRoomTempDisplayNameForMeeting()

◆ StartInstantMeeting()

◆ StartMeeting()

◆ StartMeetingWithHostKey()