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

This class provides interfaces to manage and control the smart summary feature in meetings. More...

#include <ZoomSDKMeetingSmartSummaryController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSmartSummarySupported
 Determines if current meeting support smart summary feature.
 
(BOOL) - isSmartSummaryEnabled
 Determines if the smart summary feature is enabled in the meeting.
 
(ZoomSDKError- canEnableSmartSummaryFeature
 Whether the current user can enable the smart summary feature for the account.
 
(ZoomSDKError- enableSmartSummaryFeature
 Enables the smart summary feature for the account.
 
(ZoomSDKError- canStartSmartSummary
 Whether the current user is able to start smart summary.
 
(ZoomSDKError- startSmartSummary
 Starts smart summary.
 
(ZoomSDKError- stopSmartSummary
 Stops smart summary.
 
(BOOL) - isSmartSummaryStarted
 Query whether smart summary is started.
 
(ZoomSDKError- canRequestEnableSmartSummaryFeature
 Whether the current user can request the admin to enable the smart summary feature for the account.
 
(ZoomSDKError- requestEnableSmartSummaryFeature
 Request the admin to enable the smart summary feature for the account.
 
(ZoomSDKError- canRequestStartSmartSummary
 Whether the current user can request the host to start the smart summary for the current meeting.
 
(ZoomSDKError- requestStartSmartSummary
 Request the host to start the smart summary for the current meeting.
 

Properties

id< ZoomSDKMeetingSmartSummaryControllerDelegatedelegate
 Delegate to receive smart summary related events.
 

Detailed Description

This class provides interfaces to manage and control the smart summary feature in meetings.

Definition at line 71 of file ZoomSDKMeetingSmartSummaryController.h.

Method Documentation

◆ canEnableSmartSummaryFeature

- (ZoomSDKError) canEnableSmartSummaryFeature

Whether the current user can enable the smart summary feature for the account.

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

References canEnableSmartSummaryFeature, canRequestEnableSmartSummaryFeature, canRequestStartSmartSummary, canStartSmartSummary, delegate, enableSmartSummaryFeature, isSmartSummaryEnabled, isSmartSummaryStarted, isSmartSummarySupported, requestEnableSmartSummaryFeature, requestStartSmartSummary, startSmartSummary, and stopSmartSummary.

Referenced by canEnableSmartSummaryFeature.

◆ canRequestEnableSmartSummaryFeature

- (ZoomSDKError) canRequestEnableSmartSummaryFeature

Whether the current user can request the admin to enable the smart summary feature for the account.

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

Referenced by canEnableSmartSummaryFeature.

◆ canRequestStartSmartSummary

- (ZoomSDKError) canRequestStartSmartSummary

Whether the current user can request the host to start the smart summary for the current meeting.

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

Referenced by canEnableSmartSummaryFeature.

◆ canStartSmartSummary

- (ZoomSDKError) canStartSmartSummary

Whether the current user is able to start smart summary.

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

Referenced by canEnableSmartSummaryFeature.

◆ enableSmartSummaryFeature

- (ZoomSDKError) enableSmartSummaryFeature

Enables the smart summary feature for the account.

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

Referenced by canEnableSmartSummaryFeature.

◆ isSmartSummaryEnabled

- (BOOL) isSmartSummaryEnabled

Determines if the smart summary feature is enabled in the meeting.

Returns
YES if the smart summary feature is enabled. Otherwise, NO.

Referenced by canEnableSmartSummaryFeature.

◆ isSmartSummaryStarted

- (BOOL) isSmartSummaryStarted

Query whether smart summary is started.

Returns
YES if smart summary is started. Otherwise, NO.

Referenced by canEnableSmartSummaryFeature.

◆ isSmartSummarySupported

- (BOOL) isSmartSummarySupported

Determines if current meeting support smart summary feature.

Returns
YES if the current meeting supports the smart summary feature. Otherwise, NO.

Referenced by canEnableSmartSummaryFeature.

◆ requestEnableSmartSummaryFeature

- (ZoomSDKError) requestEnableSmartSummaryFeature

Request the admin to enable the smart summary feature for the account.

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

Referenced by canEnableSmartSummaryFeature.

◆ requestStartSmartSummary

- (ZoomSDKError) requestStartSmartSummary

Request the host to start the smart summary for the current meeting.

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

Referenced by canEnableSmartSummaryFeature.

◆ startSmartSummary

- (ZoomSDKError) startSmartSummary

Starts smart summary.

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

Referenced by canEnableSmartSummaryFeature.

◆ stopSmartSummary

- (ZoomSDKError) stopSmartSummary

Stops smart summary.

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

Referenced by canEnableSmartSummaryFeature.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingSmartSummaryControllerDelegate>) delegate
readwritenonatomicassign

Delegate to receive smart summary related events.

Definition at line 75 of file ZoomSDKMeetingSmartSummaryController.h.

Referenced by canEnableSmartSummaryFeature.