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

Provides control and status APIs for Zoom meeting production studio mode. More...

#include <ZoomSDKMeetingProductionStudioController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSupportPSMode
 Returns if production studio mode is supported.
 
(BOOL) - canStartPSMode
 Determines if you have permission to start production studio mode. Only the host or cohost can start production studio mode.
 
(ZoomSDKError- startPSMode:
 Starts production studio mode. After starting, send data to video and audio publication to production studio through the ZoomSDKPSSender interface.
 
(ZoomSDKError- stopPSMode
 Stops production studio mode.
 
(BOOL) - isPSModeStarted
 Determines if production studio mode has started.
 
(unsigned int) - getPSUserID
 Returns the current production studio user ID.
 

Properties

id< ZoomSDKMeetingProductionStudioControllerDelegatedelegate
 

Detailed Description

Provides control and status APIs for Zoom meeting production studio mode.

Definition at line 101 of file ZoomSDKMeetingProductionStudioController.h.

Method Documentation

◆ canStartPSMode

- (BOOL) canStartPSMode

Determines if you have permission to start production studio mode. Only the host or cohost can start production studio mode.

Returns
If you have permission to start production studio mode, return YES. Otherwise return NO.

◆ getPSUserID

- (unsigned int) getPSUserID

Returns the current production studio user ID.

Returns
The user ID of current production studio user.

◆ isPSModeStarted

- (BOOL) isPSModeStarted

Determines if production studio mode has started.

Returns
YES if production studio mode is started. Otherwise, NO.

◆ isSupportPSMode

- (BOOL) isSupportPSMode

Returns if production studio mode is supported.

Returns
YES if production studio mode is supported. Otherwise, NO.

◆ startPSMode:

- (ZoomSDKError) startPSMode: (ZoomSDKPSVideoSourceCapability *) capability

Starts production studio mode. After starting, send data to video and audio publication to production studio through the ZoomSDKPSSender interface.

Parameters
capabilityFormat description of the video data sent.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ stopPSMode

- (ZoomSDKError) stopPSMode

Stops production studio mode.

Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingProductionStudioControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 103 of file ZoomSDKMeetingProductionStudioController.h.