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

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

#include <ZoomSDKMeetingService.h>

Inherits NSObject.

Instance Methods

(ZoomSDKMeetingUIController *) - getMeetingUIController
 Get the meeting UI controller interface.
 
(ZoomSDKMeetingConfiguration *) - getMeetingConfiguration
 Get the configuration of the meeting.
 
(ZoomSDKH323Helper *_Nullable) - getH323Helper
 Get the default H.323 helper of ZOOM meeting service.
 
(ZoomSDKWaitingRoomController *) - getWaitingRoomController
 Get default Waiting Room Controller of ZOOM meeting service.
 
(ZoomSDKASController *) - getASController
 Get the default AS(APP share) Controller of ZOOM meeting service.
 
(ZoomSDKPhoneHelper *) - getPhoneHelper
 Get the default Phone Callout Helper of Zoom meeting service.
 
(ZoomSDKMeetingActionController *) - getMeetingActionController
 Get the default action controller(mute audio/video etc) of ZOOM meeting service.
 
(ZoomSDKLiveStreamHelper *) - getLiveStreamHelper
 Get the default live stream helper of ZOOM meeting service.
 
(ZoomSDKVideoContainer *_Nullable) - getVideoContainer
 Get the custom video container of ZOOM SDK.
 
(ZoomSDKMeetingRecordController *) - getRecordController
 Get the custom recording object of ZOOM SDK.
 
(ZoomSDKWebinarController *) - getWebinarController
 Get the custom webinar controller.
 
(ZoomSDKCloseCaptionController *) - getCloseCaptionController
 Get controller of close caption in Zoom meeting.
 
(ZoomSDKRealNameAuthenticationController *) - getRealNameController
 Get object of controller ZoomSDKRealNameAuthenticationController.
 
(ZoomSDKQAController *) - getQAController
 Get object of ZoomSDKQAController.
 
(ZoomSDKNewBreakoutRoomController *) - getNewBreakoutRoomController
 Get object of ZoomSDKNewBreakoutRoomController.
 
(ZoomSDKInterpretationController *) - getInterpretationController
 Get object of ZoomSDKInterpretationController.
 
(ZoomSDKSignInterpretationController *) - getSignInterpretationController
 Get object of ZoomSDKSignInterpretationController.
 
(ZoomSDKReactionController *) - getReactionController
 Get object of ZoomSDKReactionController.
 
(ZoomSDKAppSignalController *_Nullable) - getAppSignalController
 Get object of ZoomSDKAppSignalController.
 
(ZoomSDKRawArchivingController *) - getRawArchivingController
 Get object of ZoomSDKRawArchivingController.
 
(ZoomSDKCustomImmersiveController *_Nullable) - getMeetingImmersiveController
 Get the immersive controller.
 
(ZoomSDKMeetingWhiteboardController *) - getMeetingWhiteboardController
 Get the whiteboard controller.
 
(ZoomSDKMeetingChatController *) - getMeetingChatController
 Get the meeting chat controller.
 
(ZoomSDKMeetingEncryptionController *) - getInMeetingEncryptionController
 Get the encryption controller.
 
(ZoomSDKMeetingRemoteSupportController *) - getMeetingRemoteSupportController
 Get the remote support controller.
 
(NSString *) - getInMeetingDataCenterInfo
 Get data center info.
 
(ZoomSDKPollingController *) - getMeetingPollingController
 Get the meeting polling controller.
 
(ZoomSDKMeetingAICompanionController *) - getInMeetingAICompanionController
 Get the meeting AI companion controller.
 
(ZoomSDKCameraControlHelper *_Nullable) - getCameraControlHelper:
 Get camera controller object, can control any user's cameras.
 
(ZoomSDKMeetingProductionStudioController *) - getMeetingProductionStudioController
 Get the production studio controller object.
 
(ZoomSDKError- revokeCameraControlPrivilege
 Revoke camera control privilege.
 
(ZoomSDKMeetingIndicatorController *_Nullable) - getMeetingIndicatorController
 Get indicator controller object.
 
(ZoomSDKMeetingDocsController *_Nullable) - getMeetingDocsController
 Get docs controller object.
 
(ZoomSDKError- startMeeting:
 Start a ZOOM meeting with meeting number for login user.
 
(ZoomSDKError- startMeetingWithZAK:
 Start a ZOOM meeting with ZAK.
 
(ZoomSDKError- joinMeeting:
 Join a Zoom meeting.
 
(void) - leaveMeetingWithCmd:
 End/Leave the current meeting.
 
(ZoomSDKMeetingStatus- getMeetingStatus
 Get the status of meeting.
 
(NSString *_Nullable) - getMeetingProperty:
 Get the property of meeting.
 
(int) - getSupportedMeetingAudioType
 Get the audio type supported by the current meeting.
 
(ZoomSDKConnectionQuality- getConnectionQuality:Sending:
 Get the network quality of meeting connection.
 
(MeetingType- getMeetingType
 Get the type of current meeting.
 
(BOOL) - isFailoverMeeting
 Determine whether the meeting is failover or not.
 
(ZoomSDKError- handleZoomWebUrlAction:
 Handle the event that user joins meeting from web or meeting URL.
 
(CGSize) - getUserVideoSize:
 Get the size of user's video.
 

Protected Attributes

id< ZoomSDKMeetingServiceDelegate_delegate
 
ZoomSDKMeetingUIController_meetingUIController
 
ZoomSDKMeetingConfiguration_meetingConfiguration
 
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
 
ZoomSDKReactionController_reactionController
 
ZoomSDKAppSignalController_appSignalController
 
ZoomSDKRawArchivingController_rawArchivingController
 
ZoomSDKSignInterpretationController_signInterpretationController
 
ZoomSDKCustomImmersiveController_customImmersiveController
 
ZoomSDKMeetingChatController_chatController
 
ZoomSDKMeetingWhiteboardController_whiteboardController
 
ZoomSDKMeetingEncryptionController_encryptionController
 
ZoomSDKPollingController_pollingController
 
ZoomSDKMeetingRemoteSupportController_remoteSupportController
 
ZoomSDKMeetingAICompanionController_AICompanionController
 
ZoomSDKMeetingIndicatorController_meetingIndicatorController
 
ZoomSDKMeetingProductionStudioController_productionStudioController
 
ZoomSDKMeetingDocsController_meetingDocsController
 

Properties

id< ZoomSDKMeetingServiceDelegatedelegate
 

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.

Definition at line 414 of file ZoomSDKMeetingService.h.

Method Documentation

◆ getAppSignalController

- (ZoomSDKAppSignalController *_Nullable) getAppSignalController

Get object of ZoomSDKAppSignalController.

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

◆ 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.

◆ getCameraControlHelper:

- (ZoomSDKCameraControlHelper *_Nullable) getCameraControlHelper: (unsigned int) userId

Get camera controller object, can control any user's cameras.

Parameters
userIdControls user's own camera.
Returns
If the function succeeds, the return value is a pointer to ZoomSDKCameraControlHelper. Otherwise, the function 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
componentVideo/audio/share.
sendingSet 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 *_Nullable) 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.

◆ getInMeetingAICompanionController

- (ZoomSDKMeetingAICompanionController *) getInMeetingAICompanionController

Get the meeting AI companion controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingAICompanionController. Otherwise, the function returns nil.

◆ getInMeetingDataCenterInfo

- (NSString *) getInMeetingDataCenterInfo

Get data center info.

Returns
If the function succeeds, it will return data center details. Otherwise failed.

◆ getInMeetingEncryptionController

- (ZoomSDKMeetingEncryptionController *) getInMeetingEncryptionController

Get the encryption controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingEncryptionController. Otherwise, the function returns nil.

◆ 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.

◆ getMeetingChatController

- (ZoomSDKMeetingChatController *) getMeetingChatController

Get the meeting chat controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingChatController. Otherwise, the function 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.

◆ getMeetingDocsController

- (ZoomSDKMeetingDocsController *_Nullable) getMeetingDocsController

Get docs controller object.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingDocsController. Otherwise, the function returns nil.

◆ getMeetingImmersiveController

- (ZoomSDKCustomImmersiveController *_Nullable) getMeetingImmersiveController

Get the immersive controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKCustomImmersiveController. Otherwise, the function returns nil.

◆ getMeetingIndicatorController

- (ZoomSDKMeetingIndicatorController *_Nullable) getMeetingIndicatorController

Get indicator controller object.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingIndicatorController. Otherwise, the function returns nil.

◆ getMeetingPollingController

- (ZoomSDKPollingController *) getMeetingPollingController

Get the meeting polling controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKPollingController. Otherwise, the function returns nil.

◆ getMeetingProductionStudioController

- (ZoomSDKMeetingProductionStudioController *) getMeetingProductionStudioController

Get the production studio controller object.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingProductionStudioController. Otherwise, the function returns nil.

◆ getMeetingProperty:

- (NSString *_Nullable) getMeetingProperty: (MeetingPropertyCmd) command

Get the property of meeting.

Parameters
commandCommands for user to get different properties.
Returns
If the function succeeds, it will return an NSString of meeting property, otherwise failed.

◆ getMeetingRemoteSupportController

- (ZoomSDKMeetingRemoteSupportController *) getMeetingRemoteSupportController

Get the remote support controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingRemoteSupportController. Otherwise, the function returns nil.

◆ 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.

◆ getMeetingWhiteboardController

- (ZoomSDKMeetingWhiteboardController *) getMeetingWhiteboardController

Get the whiteboard controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingWhiteboardController. Otherwise, the function 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.

◆ getRawArchivingController

- (ZoomSDKRawArchivingController *) getRawArchivingController

Get object of ZoomSDKRawArchivingController.

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

◆ getReactionController

- (ZoomSDKReactionController *) getReactionController

Get object of ZoomSDKReactionController.

Returns
If the function succeeds, it will return a ZoomSDKReactionController 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.

◆ getSignInterpretationController

- (ZoomSDKSignInterpretationController *) getSignInterpretationController

Get object of ZoomSDKSignInterpretationController.

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

◆ getSupportedMeetingAudioType

- (int) getSupportedMeetingAudioType

Get the audio type supported by the current meeting.

Returns
If the function succeeds, it will return the audio type supported by the current meeting. The value is the 'bitwise OR' of each supported audio type. For more details, see .

◆ getUserVideoSize:

- (CGSize) getUserVideoSize: (unsigned int) userID

Get the size of user's video.

Parameters
userIDThe ID of user in the meeting. UserID should be 0 when not in meeting.
Returns
The size of user's video.

◆ getVideoContainer

- (ZoomSDKVideoContainer *_Nullable) 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
urlActionThe 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.

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

◆ joinMeeting:

- (ZoomSDKError) joinMeeting: (ZoomSDKJoinMeetingElements *) context

Join a Zoom meeting.

Parameters
contextIt is a ZoomSDKJoinMeetingElements class,contain all params to join meeting.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.
Note
toke4enfrocelogin/customerKey is for API user.

◆ leaveMeetingWithCmd:

- (void) leaveMeetingWithCmd: (LeaveMeetingCmd) cmd

End/Leave the current meeting.

Parameters
cmdThe command for leaving the current meeting. Only host can end the meeting.

◆ revokeCameraControlPrivilege

- (ZoomSDKError) revokeCameraControlPrivilege

Revoke camera control privilege.

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

◆ startMeeting:

- (ZoomSDKError) startMeeting: (ZoomSDKStartMeetingElements *) context

Start a ZOOM meeting with meeting number for login user.

Parameters
contextIt 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.

Parameters
contextIt is a ZoomSDKStartMeetingUseZakElements class,contain all params to start meeting with zak.
Returns
If the function succeeds, it will return the ZoomSDKError_Success, otherwise failed.
Note
It is just for non-logged-in user.

Field Documentation

◆ _actionController

- (ZoomSDKMeetingActionController*) _actionController
protected

Definition at line 423 of file ZoomSDKMeetingService.h.

◆ _AICompanionController

- (ZoomSDKMeetingAICompanionController*) _AICompanionController
protected

Definition at line 444 of file ZoomSDKMeetingService.h.

◆ _appSignalController

- (ZoomSDKAppSignalController*) _appSignalController
protected

Definition at line 435 of file ZoomSDKMeetingService.h.

◆ _asController

- (ZoomSDKASController*) _asController
protected

Definition at line 422 of file ZoomSDKMeetingService.h.

◆ _chatController

- (ZoomSDKMeetingChatController*) _chatController
protected

Definition at line 439 of file ZoomSDKMeetingService.h.

◆ _closeCaptionController

- (ZoomSDKCloseCaptionController*) _closeCaptionController
protected

Definition at line 429 of file ZoomSDKMeetingService.h.

◆ _customImmersiveController

- (ZoomSDKCustomImmersiveController*) _customImmersiveController
protected

Definition at line 438 of file ZoomSDKMeetingService.h.

◆ _delegate

- (id<ZoomSDKMeetingServiceDelegate>) _delegate
protected

Definition at line 416 of file ZoomSDKMeetingService.h.

◆ _encryptionController

- (ZoomSDKMeetingEncryptionController*) _encryptionController
protected

Definition at line 441 of file ZoomSDKMeetingService.h.

◆ _h323Helper

- (ZoomSDKH323Helper*) _h323Helper
protected

Definition at line 419 of file ZoomSDKMeetingService.h.

◆ _InterpretationController

- (ZoomSDKInterpretationController*) _InterpretationController
protected

Definition at line 433 of file ZoomSDKMeetingService.h.

◆ _liveStreamHelper

- (ZoomSDKLiveStreamHelper*) _liveStreamHelper
protected

Definition at line 424 of file ZoomSDKMeetingService.h.

◆ _meetingConfiguration

- (ZoomSDKMeetingConfiguration*) _meetingConfiguration
protected

Definition at line 418 of file ZoomSDKMeetingService.h.

◆ _meetingDocsController

- (ZoomSDKMeetingDocsController*) _meetingDocsController
protected

Definition at line 447 of file ZoomSDKMeetingService.h.

◆ _meetingIndicatorController

- (ZoomSDKMeetingIndicatorController*) _meetingIndicatorController
protected

Definition at line 445 of file ZoomSDKMeetingService.h.

◆ _meetingUIController

- (ZoomSDKMeetingUIController*) _meetingUIController
protected

Definition at line 417 of file ZoomSDKMeetingService.h.

◆ _newBOController

- (ZoomSDKNewBreakoutRoomController*) _newBOController
protected

Definition at line 432 of file ZoomSDKMeetingService.h.

◆ _phoneHelper

- (ZoomSDKPhoneHelper*) _phoneHelper
protected

Definition at line 421 of file ZoomSDKMeetingService.h.

◆ _pollingController

- (ZoomSDKPollingController*) _pollingController
protected

Definition at line 442 of file ZoomSDKMeetingService.h.

◆ _productionStudioController

- (ZoomSDKMeetingProductionStudioController*) _productionStudioController
protected

Definition at line 446 of file ZoomSDKMeetingService.h.

◆ _QAController

- (ZoomSDKQAController*) _QAController
protected

Definition at line 431 of file ZoomSDKMeetingService.h.

◆ _rawArchivingController

- (ZoomSDKRawArchivingController*) _rawArchivingController
protected

Definition at line 436 of file ZoomSDKMeetingService.h.

◆ _reactionController

- (ZoomSDKReactionController*) _reactionController
protected

Definition at line 434 of file ZoomSDKMeetingService.h.

◆ _realNameController

- (ZoomSDKRealNameAuthenticationController*) _realNameController
protected

Definition at line 430 of file ZoomSDKMeetingService.h.

◆ _recordController

- (ZoomSDKMeetingRecordController*) _recordController
protected

Definition at line 427 of file ZoomSDKMeetingService.h.

◆ _remoteSupportController

- (ZoomSDKMeetingRemoteSupportController*) _remoteSupportController
protected

Definition at line 443 of file ZoomSDKMeetingService.h.

◆ _signInterpretationController

- (ZoomSDKSignInterpretationController*) _signInterpretationController
protected

Definition at line 437 of file ZoomSDKMeetingService.h.

◆ _videoContainer

- (ZoomSDKVideoContainer*) _videoContainer
protected

Definition at line 426 of file ZoomSDKMeetingService.h.

◆ _waitingRoomController

- (ZoomSDKWaitingRoomController*) _waitingRoomController
protected

Definition at line 420 of file ZoomSDKMeetingService.h.

◆ _webinarController

- (ZoomSDKWebinarController*) _webinarController
protected

Definition at line 428 of file ZoomSDKMeetingService.h.

◆ _whiteboardController

- (ZoomSDKMeetingWhiteboardController*) _whiteboardController
protected

Definition at line 440 of file ZoomSDKMeetingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingServiceDelegate>) delegate
readwritenonatomicassign

Callback of receiving meeting events.

Definition at line 452 of file ZoomSDKMeetingService.h.