IMeetingH323Helper Class Reference

Meeting H323 Helper Interface. More...

#include <meeting_h323_helper_interface.h>

Public Member Functions
virtual void	SetEvent (IMeetingH323HelperEvent *pEvent)=0
	Set meeting H.323 helper callback event handler.
virtual IList< const zchar_t * > *	GetH323Address ()=0
	Get the list of H.323 call-in number supported by the current meeting.
virtual const zchar_t *	GetH323Password ()=0
	Get the H.323 password for the current meeting.
virtual SDKError	CanPairingMeeting (UINT64 meetingNum)=0
	Determine if it is enabled to pair the meeting.
virtual SDKError	SendMeetingParingCode (UINT64 meetingNum, zchar_t *paringCode)=0
	Send Meeting paring code.
virtual IList< IH323Device * > *	GetCalloutH323DeviceList ()=0
	Get the list of the call-out devices supported by the current meeting.
virtual SDKError	CallOutH323 (IH323Device *deviceInfo)=0
	Call out with the assigned H.323 device.
virtual SDKError	CancelCallOutH323 ()=0
	Cancel current outgoing call.

Detailed Description

Meeting H323 Helper Interface.

Definition at line 157 of file meeting_h323_helper_interface.h.

Member Function Documentation

CallOutH323()

virtual SDKError IMeetingH323Helper::CallOutH323 ( IH323Device * deviceInfo )

pure virtual

Call out with the assigned H.323 device.

Parameters

deviceInfo

Specify the H.323 device to use. For more details, see IH323Device.

Returns

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

Remarks

If the function succeeds, the IMeetingH323HelperEvent::onCalloutStatusNotify() will be triggered once the callout status of H.323 device changes.

CancelCallOutH323()

virtual SDKError IMeetingH323Helper::CancelCallOutH323 ( )

pure virtual

Cancel current outgoing call.

Returns

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

CanPairingMeeting()

virtual SDKError IMeetingH323Helper::CanPairingMeeting ( UINT64 meetingNum )

pure virtual

Determine if it is enabled to pair the meeting.

Parameters

meetingNum

TRUE Specifies the meeting number.

Returns

If pairing meeting is enabled, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

GetCalloutH323DeviceList()

virtual IList< IH323Device * > * IMeetingH323Helper::GetCalloutH323DeviceList ( )

pure virtual

Get the list of the call-out devices supported by the current meeting.

Returns

If the function succeeds, the return value is the pointer to the list of devices. Otherwise failed, the return value is an empty list. For more details, see IH323Device.

Remarks

The list will be cleared each time the function is called.

GetH323Address()

virtual IList< const zchar_t * > * IMeetingH323Helper::GetH323Address ( )

pure virtual

Get the list of H.323 call-in number supported by the current meeting.

Returns

If the function succeeds, the return value is the pointer to the list of the call-in number. Otherwise failed, the return value is nullptr.

GetH323Password()

virtual const zchar_t * IMeetingH323Helper::GetH323Password ( )

pure virtual

Get the H.323 password for the current meeting.

Returns

If the function succeeds, the return value is the H.323 meeting connect password. Otherwise failed, the return value is the length of zero(0).

SendMeetingParingCode()

virtual SDKError IMeetingH323Helper::SendMeetingParingCode ( UINT64 meetingNum, zchar_t * paringCode )

pure virtual

Send Meeting paring code.

Parameters

meetingNum	Specifies which meeting to paring.
paringCode	Code for paring

Returns

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

Remarks

If the function succeeds, the IMeetingH323HelperEvent::onParingH323Result() will be triggered once received the response of the H.323 device.

SetEvent()

virtual void IMeetingH323Helper::SetEvent ( IMeetingH323HelperEvent * pEvent )

pure virtual

Set meeting H.323 helper callback event handler.

Parameters

pEvent

A pointer to the IMeetingH323HelperEvent that receives H.323 helper event.