Third Party Meeting helper interface. More...

#include <IThirdPartyMeetingHelper.h>

Public Member Functions
virtual	~IThirdPartyMeetingHelper ()

virtual ZRCSDKError	RegisterSink (IThirdPartyMeetingHelperSink *pSink)=0
	Register third party meeting helper callback sink.

virtual ZRCSDKError	DeregisterSink (IThirdPartyMeetingHelperSink *pSink)=0
	Deregister third party meeting helper callback sink.

virtual ZRCSDKError	CallOutPSTNUser (const std::string &phoneNumber, bool cancelCall, bool hasVoicePrompt)=0
	Dial out a PSTN user.

virtual ZRCSDKError	StartThirdPartyMeetingByPSTNCall (const MeetingItem &meeting)=0
	Start the third party meeting by PSTN call.

virtual ZRCSDKError	SwitchPstnCallToMeeting ()=0
	Switch a PSTN call to normal Zoom Meeting.

virtual ZRCSDKError	StartThirdPartyMeetingByRoomSystemCall (const MeetingItem &meeting)=0
	Start the third party meeting by room system call.

virtual ZRCSDKError	StartIntegrationMeeting (const MeetingItem &meeting)=0
	Join integration meeting in meeting list.

virtual ZRCSDKError	JoinIntegrationMeeting (const std::string &meetingID, const std::string &password, ThirdPartyMeetingServiceProvider provider)=0
	Join integration meeting via meeting id.

virtual ZRCSDKError	RejoinIntegrationMeeting ()=0
	Rejoin the integration meeting in the integration meeting.

virtual ZRCSDKError	LeaveIntegrationMeeting ()=0
	Leave the current integration meeting.

virtual ZRCSDKError	MuteIntegrationAudio (bool mute)=0
	Mute or unmute self audio.

virtual ZRCSDKError	StopIntegrationVideo (bool stop)=0
	Stop or start self video.

virtual ZRCSDKError	StopIntegrationContentShare (bool stop)=0
	Stop integration meeting content share.

virtual ZRCSDKError	ChangeIntegrationLayout (uint32_t selectedLayoutType)=0
	Change integration meeting layout.

virtual ZRCSDKError	GetInterOperabilityInfoByMeetingType (ThirdPartyMeetingServiceProvider meetingType, InterOperabilityInfo &info)=0
	Get inter operability info by integration meeting type.

Detailed Description

Third Party Meeting helper interface.

Definition at line 287 of file IThirdPartyMeetingHelper.h.

Constructor & Destructor Documentation

◆ ~IThirdPartyMeetingHelper()

virtual IThirdPartyMeetingHelper::~IThirdPartyMeetingHelper ( )

inlinevirtual

Definition at line 290 of file IThirdPartyMeetingHelper.h.

290{}

Member Function Documentation

◆ CallOutPSTNUser()

virtual ZRCSDKError IThirdPartyMeetingHelper::CallOutPSTNUser	(	const std::string &	phoneNumber,
		bool	cancelCall,
		bool	hasVoicePrompt
	)

pure virtual

Dial out a PSTN user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

phoneNumber	Specify the phone number to be called.
cancelCall	TRUE indicates to cancel the call.
hasVoicePrompt	TRUE indicates to ring on Zoom Room.

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

◆ ChangeIntegrationLayout()

virtual ZRCSDKError IThirdPartyMeetingHelper::ChangeIntegrationLayout ( uint32_t selectedLayoutType )

pure virtual

Change integration meeting layout.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

selectedLayoutType Specify the layout type.

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

◆ DeregisterSink()

virtual ZRCSDKError IThirdPartyMeetingHelper::DeregisterSink ( IThirdPartyMeetingHelperSink * pSink )

pure virtual

Deregister third party meeting helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IThirdPartyMeetingHelperSink that receives the third party meeting helper callback.

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

◆ GetInterOperabilityInfoByMeetingType()

virtual ZRCSDKError IThirdPartyMeetingHelper::GetInterOperabilityInfoByMeetingType	(	ThirdPartyMeetingServiceProvider	meetingType,
		InterOperabilityInfo &	info
	)

pure virtual

Get inter operability info by integration meeting type.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[in]	meetingType	Integration meeting type, see ThirdPartyMeetingServiceProvider enum.
[out]	info	Inter operability info, see InterOperabilityInfo struct.

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

◆ JoinIntegrationMeeting()

virtual ZRCSDKError IThirdPartyMeetingHelper::JoinIntegrationMeeting	(	const std::string &	meetingID,
		const std::string &	password,
		ThirdPartyMeetingServiceProvider	provider
	)

pure virtual

Join integration meeting via meeting id.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meetingID	The meeting id of the meeting.
password	The password of the meeting.
provider	The service provider of the integration meeting, such as ThirdPartyMeetingServiceProvider enum.

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

◆ LeaveIntegrationMeeting()

virtual ZRCSDKError IThirdPartyMeetingHelper::LeaveIntegrationMeeting ( )

pure virtual

Leave the current integration 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.

◆ MuteIntegrationAudio()

virtual ZRCSDKError IThirdPartyMeetingHelper::MuteIntegrationAudio ( bool mute )

pure virtual

Mute or unmute self audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates mute self audio. Otherwise not.

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

◆ RegisterSink()

virtual ZRCSDKError IThirdPartyMeetingHelper::RegisterSink ( IThirdPartyMeetingHelperSink * pSink )

pure virtual

Register third party meeting helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IThirdPartyMeetingHelperSink that receives the third party meeting helper callback.

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

◆ RejoinIntegrationMeeting()

virtual ZRCSDKError IThirdPartyMeetingHelper::RejoinIntegrationMeeting ( )

pure virtual

Rejoin the integration meeting in the integration 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.

◆ StartIntegrationMeeting()

virtual ZRCSDKError IThirdPartyMeetingHelper::StartIntegrationMeeting ( const MeetingItem & meeting )

pure virtual

Join integration meeting in meeting list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meeting The integration meeting item.

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

◆ StartThirdPartyMeetingByPSTNCall()

virtual ZRCSDKError IThirdPartyMeetingHelper::StartThirdPartyMeetingByPSTNCall ( const MeetingItem & meeting )

pure virtual

Start the third party meeting by PSTN call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meeting The third party meeting item.

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

◆ StartThirdPartyMeetingByRoomSystemCall()

virtual ZRCSDKError IThirdPartyMeetingHelper::StartThirdPartyMeetingByRoomSystemCall ( const MeetingItem & meeting )

pure virtual

Start the third party meeting by room system call.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

meeting The third party meeting item.

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

◆ StopIntegrationContentShare()

virtual ZRCSDKError IThirdPartyMeetingHelper::StopIntegrationContentShare ( bool stop )

pure virtual

Stop integration meeting content share.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

stop	TRUE indicates stop. Otherwise not.

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

◆ StopIntegrationVideo()

virtual ZRCSDKError IThirdPartyMeetingHelper::StopIntegrationVideo ( bool stop )

pure virtual

Stop or start self video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

stop	TRUE indicates stop self video. Otherwise not.

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

◆ SwitchPstnCallToMeeting()

virtual ZRCSDKError IThirdPartyMeetingHelper::SwitchPstnCallToMeeting ( )

pure virtual

Switch a PSTN call to normal Zoom 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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IThirdPartyMeetingHelper()

Member Function Documentation

◆ CallOutPSTNUser()

◆ ChangeIntegrationLayout()

◆ DeregisterSink()

◆ GetInterOperabilityInfoByMeetingType()

◆ JoinIntegrationMeeting()

◆ LeaveIntegrationMeeting()

◆ MuteIntegrationAudio()

◆ RegisterSink()

◆ RejoinIntegrationMeeting()

◆ StartIntegrationMeeting()

◆ StartThirdPartyMeetingByPSTNCall()

◆ StartThirdPartyMeetingByRoomSystemCall()

◆ StopIntegrationContentShare()

◆ StopIntegrationVideo()

◆ SwitchPstnCallToMeeting()