Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKH323Helper Class Reference

Provides helper APIs for H.323 device management in Zoom meetings. More...

#include <ZoomSDKH323Helper.h>

Inherits NSObject.

Instance Methods

(NSArray *) - getH323DeviceAddress
 Get the H.323 device address of the current meeting.
 
(NSString *) - getH323Password
 Get the H.323 device password of the current meeting.
 
(ZoomSDKError- sendMeetingPairingCode:meetingNum:
 Send meeting paring code.
 
(ZoomSDKError- calloutH323Device:
 This method is used to call out a H.323 device.
 
(NSArray *_Nullable) - getRoomH323DeviceArray
 Get the list of H.323 devices for the current meeting.
 
(ZoomSDKError- cancelCallOutH323
 Cancel the latest operation of calling out H.323 device.
 
(ZoomSDKError- inviteToMeetingByDefaultMail
 This method is used to invite others to meeting by default email.
 
(ZoomSDKError- inviteToMeetingByGmail
 This method is used to invite others to meeting by gmail.
 
(ZoomSDKError- inviteToMeetingByYahooMail
 This method is used to invite others to meeting by Yahoo mail.
 

Protected Attributes

id< ZoomSDKH323HelperDelegate_delegate
 

Properties

id< ZoomSDKH323HelperDelegatedelegate
 Set or get the delegate to receive H.323 related events.
 

Detailed Description

Provides helper APIs for H.323 device management in Zoom meetings.

Definition at line 71 of file ZoomSDKH323Helper.h.

Method Documentation

◆ calloutH323Device:

- (ZoomSDKError) calloutH323Device: (H323DeviceInfo *) deviceInfo

This method is used to call out a H.323 device.

Parameters
deviceInfoThe information of H.323 device that you want to call out.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ cancelCallOutH323

- (ZoomSDKError) cancelCallOutH323

Cancel the latest operation of calling out H.323 device.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ getH323DeviceAddress

- (NSArray *) getH323DeviceAddress

Get the H.323 device address of the current meeting.

Returns
If the function succeeds, it will return the address. Otherwise failed.

◆ getH323Password

- (NSString *) getH323Password

Get the H.323 device password of the current meeting.

Returns
If the function succeeds, it will return the password. Otherwise failed.

◆ getRoomH323DeviceArray

- (NSArray *_Nullable) getRoomH323DeviceArray

Get the list of H.323 devices for the current meeting.

Returns
If the function succeeds, it will return the list, otherwise not.

◆ inviteToMeetingByDefaultMail

- (ZoomSDKError) inviteToMeetingByDefaultMail

This method is used to invite others to meeting by default email.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ inviteToMeetingByGmail

- (ZoomSDKError) inviteToMeetingByGmail

This method is used to invite others to meeting by gmail.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ inviteToMeetingByYahooMail

- (ZoomSDKError) inviteToMeetingByYahooMail

This method is used to invite others to meeting by Yahoo mail.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ sendMeetingPairingCode:meetingNum:

- (ZoomSDKError) sendMeetingPairingCode: (NSString *) pairCode
meetingNum: (long long) meetingNum 

Send meeting paring code.

Parameters
pairCodePairing code of the specified meeting.
meetingNumMeeting number for pairing.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

Field Documentation

◆ _delegate

- (id<ZoomSDKH323HelperDelegate>) _delegate
protected

Definition at line 73 of file ZoomSDKH323Helper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKH323HelperDelegate>) delegate
readwritenonatomicassign

Set or get the delegate to receive H.323 related events.

Definition at line 78 of file ZoomSDKH323Helper.h.