It is an implementation for client to start/join a Meeting. More...

#import <ZoomSDKMeetingService.h>

Inheritance diagram for ZoomSDKMeetingService:

Instance Methods
(ZoomSDKMeetingUIController *)	- getMeetingUIController
	Get the meeting UI controller interface. More...

(ZoomSDKMeetingConfiguration *)	- getMeetingConfiguration
	Get the configuration of the meeting. More...

(ZoomSDKH323Helper *)	- getH323Helper
	Get the default H.323 helper of ZOOM meeting service. More...

(ZoomSDKBreakoutRoomsController *)	- getBreakoutRoomsController
	Get the default Breakout Rooms Helper of ZOOM meeting service. More...

(ZoomSDKWaitingRoomController *)	- getWaitingRoomController
	Get default Waiting Room Controller of ZOOM meeting service. More...

(ZoomSDKASController *)	- getASController
	Get the default AS(APP share) Controller of ZOOM meeting service. More...

(ZoomSDKPhoneHelper *)	- getPhoneHelper
	Get the default Phone Callout Helper of Zoom meeting service. More...

(ZoomSDKMeetingActionController *)	- getMeetingActionController
	Get the default action controller(mute audio/video etc) of ZOOM meeting service. More...

(ZoomSDKLiveStreamHelper *)	- getLiveStreamHelper
	Get the default live stream helper of ZOOM meeting service. More...

(ZoomSDKVideoContainer *)	- getVideoContainer
	Get the custom video container of ZOOM SDK. More...

(ZoomSDKMeetingRecordController *)	- getRecordController
	Get the custom recording object of ZOOM SDK. More...

(ZoomSDKWebinarController *)	- getWebinarController
	Get the custom webinar controller. More...

(ZoomSDKCloseCaptionController *)	- getCloseCaptionController
	Get controller of close caption in Zoom meeting. More...

(ZoomSDKRealNameAuthenticationController *)	- getRealNameController
	Get object of controller ZoomSDKRealNameAuthenticationController. More...

(ZoomSDKQAController *)	- getQAController
	Get object of ZoomSDKQAController. More...

(ZoomSDKNewBreakoutRoomController *)	- getNewBreakoutRoomController
	Get object of ZoomSDKNewBreakoutRoomController. More...

(ZoomSDKInterpretationController *)	- getInterpretationController
	Get object of ZoomSDKInterpretationController. More...

(ZoomSDKError)	- startMeeting:
	Start a ZOOM meeting with meeting number for login user. More...

(ZoomSDKError)	- startMeetingWithZAK:
	Start a ZOOM meeting with ZAK. More...

(ZoomSDKError)	- joinMeeting:
	Join a Zoom meeting. More...

(void)	- leaveMeetingWithCmd:
	End/Leave the current meeting. More...

(ZoomSDKMeetingStatus)	- getMeetingStatus
	Get the status of meeting. More...

(NSString *)	- getMeetingProperty:
	Get the property of meeting. More...

(ZoomSDKConnectionQuality)	- getConnectionQuality:Sending:
	Get the network quality of meeting connection. More...

(MeetingType)	- getMeetingType
	Get the type of current meeting. More...

(BOOL)	- isInternalMeeting
	Determine whether the current meeting is internal or not. Available only for Huawei. More...

(BOOL)	- isFailoverMeeting
	Determine whether the meeting is failover or not. Available only for Huawei. More...

(ZoomSDKError)	- setSecuritySessionKey:isLeaveMeeting:
	This method is used to set security session key and iv for audio/video etc. Available only for Huawei. More...

(ZoomSDKError)	- handleZoomWebUrlAction:
	Handle the event that user joins meeting from web or meeting URL. More...

Protected Attributes
id< ZoomSDKMeetingServiceDelegate >	_delegate

ZoomSDKMeetingUIController *	_meetingUIController

ZoomSDKMeetingConfiguration *	_meetingConfiguration

ZoomSDKBreakoutRoomsController *	_boController

ZoomSDKH323Helper *	_h323Helper

ZoomSDKWaitingRoomController *	_waitingRoomController

ZoomSDKPhoneHelper *	_phoneHelper

ZoomSDKASController *	_asController

ZoomSDKMeetingActionController *	_actionController

ZoomSDKLiveStreamHelper *	_liveStreamHelper

ZoomSDKVideoContainer *	_videoContainer

ZoomSDKMeetingRecordController *	_recordController

ZoomSDKWebinarController *	_webinarController

ZoomSDKCloseCaptionController *	_closeCaptionController

ZoomSDKRealNameAuthenticationController *	_realNameController

ZoomSDKQAController *	_QAController

ZoomSDKNewBreakoutRoomController *	_newBOController

ZoomSDKInterpretationController *	_InterpretationController

Properties
id< ZoomSDKMeetingServiceDelegate >	delegate

Detailed Description

It is an implementation for client to start/join a Meeting.

Note: The meeting service allows only one concurrent operation at a time, which means, only one API call is in progress at any given time.

Method Documentation

◆ getASController

- (ZoomSDKASController*) getASController

Get the default AS(APP share) Controller of ZOOM meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKASController. Otherwise returns nil.

◆ getBreakoutRoomsController

- (ZoomSDKBreakoutRoomsController*) getBreakoutRoomsController

Get the default Breakout Rooms Helper of ZOOM meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKBreakoutRoomsController. Otherwise returns nil.

◆ getCloseCaptionController

- (ZoomSDKCloseCaptionController*) getCloseCaptionController

Get controller of close caption in Zoom meeting.

Returns: If the function succeeds, it will return a ZoomSDKCloseCaptionController object which you can use to handle close caption in meeting.

◆ getConnectionQuality:Sending:

- (ZoomSDKConnectionQuality) getConnectionQuality:	(ConnectionComponent)	component
Sending:	(BOOL)	sending

Get the network quality of meeting connection.

Parameters

component	Video/audio/share.
sending	Set it to YES to get the status of sending data, NO to get the status of receiving data.

Returns: If the function succeeds, it will return an enumeration of network connection quality, otherwise failed.

◆ getH323Helper

- (ZoomSDKH323Helper*) getH323Helper

Get the default H.323 helper of ZOOM meeting service.

Returns: If the function succeeds, the return value is a ZoomSDKH323Helper object of H.323 Helper.

◆ getInterpretationController

- (ZoomSDKInterpretationController*) getInterpretationController

Get object of ZoomSDKInterpretationController.

Returns: If the function succeeds, it will return a ZoomSDKInterpretationController object.

◆ getLiveStreamHelper

- (ZoomSDKLiveStreamHelper*) getLiveStreamHelper

Get the default live stream helper of ZOOM meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKLiveStreamHelper. Otherwise returns nil.

◆ getMeetingActionController

- (ZoomSDKMeetingActionController*) getMeetingActionController

Get the default action controller(mute audio/video etc) of ZOOM meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKMeetingActionController. Otherwise returns nil.

◆ getMeetingConfiguration

- (ZoomSDKMeetingConfiguration*) getMeetingConfiguration

Get the configuration of the meeting.

Returns: If the function succeeds, the return value is an object of ZoomSDKMeetingConfiguration. Otherwise returns nil.

◆ getMeetingProperty:

- (NSString*) getMeetingProperty: (MeetingPropertyCmd) command

Get the property of meeting.

Parameters

command Commands for user to get different properties.

Returns: If the function succeeds, it will return an NSString of meeting property, otherwise failed.

◆ getMeetingStatus

- (ZoomSDKMeetingStatus) getMeetingStatus

Get the status of meeting.

Returns: The status of meeting.

◆ getMeetingType

- (MeetingType) getMeetingType

Get the type of current meeting.

Returns: If the function succeeds, it will return the type of meeting, otherwise failed.

◆ getMeetingUIController

- (ZoomSDKMeetingUIController*) getMeetingUIController

Get the meeting UI controller interface.

Returns: If the function succeeds, the return value is an object of ZoomSDKMeetingUIController. Otherwise returns nil.

◆ getNewBreakoutRoomController

- (ZoomSDKNewBreakoutRoomController *) getNewBreakoutRoomController

Get object of ZoomSDKNewBreakoutRoomController.

Returns: If the function succeeds, it will return a ZoomSDKNewBreakoutRoomController object.

◆ getPhoneHelper

- (ZoomSDKPhoneHelper*) getPhoneHelper

Get the default Phone Callout Helper of Zoom meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKPhoneHelper. Otherwise returns nil.

◆ getQAController

- (ZoomSDKQAController *) getQAController

Get object of ZoomSDKQAController.

Returns: If the function succeeds, it will return a ZoomSDKQAController object.

◆ getRealNameController

- (ZoomSDKRealNameAuthenticationController *) getRealNameController

Get object of controller ZoomSDKRealNameAuthenticationController.

Returns: If the function succeeds, it will return a ZoomSDKRealNameAuthenticationController object which you can use to Real-name authentication.

◆ getRecordController

- (ZoomSDKMeetingRecordController*) getRecordController

Get the custom recording object of ZOOM SDK.

Returns: If the function succeeds, the return value is an object of ZoomSDKMeetingRecordController which allows user to customize meeting recording. Otherwise returns nil.

◆ getVideoContainer

- (ZoomSDKVideoContainer*) getVideoContainer

Get the custom video container of ZOOM SDK.

Returns: If the function succeeds, the return value is an object of ZoomSDKVideoContainer which allows user to customize in-meeting UI. Otherwise returns nil.

◆ getWaitingRoomController

- (ZoomSDKWaitingRoomController*) getWaitingRoomController

Get default Waiting Room Controller of ZOOM meeting service.

Returns: If the function succeeds, the return value is an object of ZoomSDKWaitingRoomController. Otherwise returns nil.

◆ getWebinarController

- (ZoomSDKWebinarController*) getWebinarController

Get the custom webinar controller.

Returns: If the function succeeds, the return value is an object of ZoomSDKWebinarController which allows you to customize webinar. Otherwise returns nil.

◆ handleZoomWebUrlAction:

- (ZoomSDKError) handleZoomWebUrlAction: (NSString *) urlAction

Handle the event that user joins meeting from web or meeting URL.

Parameters

urlAction The URL string got from web.

Returns: If the function succeeds, it will return ZoomSDKError_Succuss, otherwise failed.

◆ isFailoverMeeting

- (BOOL) isFailoverMeeting

Determine whether the meeting is failover or not. Available only for Huawei.

Returns: YES means the current meeting is failover, otherwise not.

◆ isInternalMeeting

- (BOOL) isInternalMeeting

Determine whether the current meeting is internal or not. Available only for Huawei.

Returns: YES means the current meeting is internal, otherwise not.

◆ joinMeeting:

- (ZoomSDKError) joinMeeting: (ZoomSDKJoinMeetingElements *) context

Join a Zoom meeting.

Note: toke4enfrocelogin/participantId is for API user.

Parameters

context It is a ZoomSDKJoinMeetingElements class,contain all params to join meeting.

Returns: If the function succeeds, it will return ZoomSDKError_Success.

◆ leaveMeetingWithCmd:

- (void) leaveMeetingWithCmd: (LeaveMeetingCmd) cmd

End/Leave the current meeting.

Parameters

cmd	The command for leaving the current meeting. Only host can end the meeting.

◆ setSecuritySessionKey:isLeaveMeeting:

- (ZoomSDKError) setSecuritySessionKey:	(NSArray *)	keyArray
isLeaveMeeting:	(BOOL)	leaveMeeting

This method is used to set security session key and iv for audio/video etc. Available only for Huawei.

Parameters

keyArray	An array of session security key.
leaveMeeting	Notification of user leaving meeting.

Returns: The result of setting security key, successfully or not.

◆ startMeeting:

- (ZoomSDKError) startMeeting: (ZoomSDKStartMeetingElements *) context

Start a ZOOM meeting with meeting number for login user.

Parameters

context It is a ZoomSDKStartMeetingElements class,contain all params to start meeting.

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

◆ startMeetingWithZAK:

- (ZoomSDKError) startMeetingWithZAK: (ZoomSDKStartMeetingUseZakElements *) context

Start a ZOOM meeting with ZAK.

Note: It is just for non-logged-in user.

Parameters

context It is a ZoomSDKStartMeetingUseZakElements class,contain all params to start meeting with zak.

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

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingServiceDelegate>) delegate

readwritenonatomicassign

Callback of receiving meeting events.

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

ZoomSDKMeetingService.h

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ getASController

◆ getBreakoutRoomsController

◆ getCloseCaptionController

◆ getConnectionQuality:Sending:

◆ getH323Helper

◆ getInterpretationController

◆ getLiveStreamHelper

◆ getMeetingActionController

◆ getMeetingConfiguration

◆ getMeetingProperty:

◆ getMeetingStatus

◆ getMeetingType

◆ getMeetingUIController

◆ getNewBreakoutRoomController

◆ getPhoneHelper

◆ getQAController

◆ getRealNameController

◆ getRecordController

◆ getVideoContainer

◆ getWaitingRoomController

◆ getWebinarController

◆ handleZoomWebUrlAction:

◆ isFailoverMeeting

◆ isInternalMeeting

◆ joinMeeting:

◆ leaveMeetingWithCmd:

◆ setSecuritySessionKey:isLeaveMeeting:

◆ startMeeting:

◆ startMeetingWithZAK:

Property Documentation

◆ delegate