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

#include <ZoomSDKMeetingProductionStudioController.h>

Inherits NSObject.

Instance Methods

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

Properties

id< ZoomSDKMeetingProductionStudioControllerDelegatedelegate
 

Detailed Description

Definition at line 78 of file ZoomSDKMeetingProductionStudioController.h.

Method Documentation

◆ canStartPSMode

- (BOOL) canStartPSMode

Determine 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's user ID.

Returns
The user ID of current production studio user.

◆ isPSModeStarted

- (BOOL) isPSModeStarted

Determine if production studio mode has started.

Returns
YES means production studio mode is started. Otherwise not.

◆ isSupportPSMode

- (BOOL) isSupportPSMode

Returns if production studio mode is supported.

Returns
YES means production studio mode is supported.

◆ startPSMode:

- (ZoomSDKError) startPSMode: (ZoomSDKPSVideoSourceCapability *) capability

Start 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, see ZoomSDKPSVideoSourceCapability.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise the function fails.

◆ stopPSMode

- (ZoomSDKError) stopPSMode

Stop production studio mode.

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

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingProductionStudioControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 80 of file ZoomSDKMeetingProductionStudioController.h.