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

#include <ZoomSDKMeetingAICompanionController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKMeetingSmartSummaryController *) - getInMeetingSmartSummaryController
 Get the smart summary controller.
 
(ZoomSDKAICompanionSmartSummaryHelper *) - getSmartSummaryHelper
 Get the smart summary controller.
 
(ZoomSDKAICompanionQueryHelper *) - getQueryHelper
 Get object of ZoomSDKAICompanionQueryHelper.
 
(BOOL) - isTurnoffAllAICompanionsSupported
 Whether the meeting supports turning off the AI Companion features.
 
(BOOL) - canTurnOffAllAICompanions
 Whether the current user can turn off the AI Companion features.
 
(ZoomSDKError- turnOffAllAICompanion:
 Turn off the AI Companion features.
 
(BOOL) - isTurnOnAllAICompanionSupported
 Whether the meeting supports turning on the AI Companion features.
 
(BOOL) - canTurnOnAllAICompanion
 Whether the current user can turn off the AI Companion features.
 
(ZoomSDKError- turnOnAllAICompanion
 Turn on all the AI Companion features. Only ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query and ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.
 
(BOOL) - canRequestTurnoffAllAICompanion
 Whether the current user can ask the host to turn off all started AI Companion features.
 
(ZoomSDKError- requestTurnoffAllAICompanion
 Request host to turn off all started AI Companion features.
 
(BOOL) - canRequestTurnOnAllAICompanion
 Whether the current user can ask the host to turn on all AI Companion features if they are enabled for the current meeting.
 
(ZoomSDKError- requestTurnOnAllAICompanion
 Ask the host to turn on all AI Companion features if they are enabled for the current meeting.
 

Properties

id< ZoomSDKMeetingAICompanionControllerDelegatedelegate
 

Detailed Description

Definition at line 88 of file ZoomSDKMeetingAICompanionController.h.

Method Documentation

◆ canRequestTurnoffAllAICompanion

- (BOOL) canRequestTurnoffAllAICompanion

Whether the current user can ask the host to turn off all started AI Companion features.

Returns
YES means the user can request host to turn off the AI Companion features.
Note
if the current user joins the meeting before the host, they can check canTurnOffAllAICompanions to turn off the AI Companion features by himself/herself. All AI features include ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartRecording can be requested to turn off at once.

◆ canRequestTurnOnAllAICompanion

- (BOOL) canRequestTurnOnAllAICompanion

Whether the current user can ask the host to turn on all AI Companion features if they are enabled for the current meeting.

Returns
YES means the user can ask the host to turn on the AI Companion features.
Note
Only ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.

◆ canTurnOffAllAICompanions

- (BOOL) canTurnOffAllAICompanions

Whether the current user can turn off the AI Companion features.

Returns
YES means the user can turn off the AI Companion features.

◆ canTurnOnAllAICompanion

- (BOOL) canTurnOnAllAICompanion

Whether the current user can turn off the AI Companion features.

Returns
YES means the user can turn off the AI Companion features.

◆ getInMeetingSmartSummaryController

- (ZoomSDKMeetingSmartSummaryController *) getInMeetingSmartSummaryController

Get the smart summary controller.

Returns
If the function succeeds, the return value is a pointer to ZoomSDKMeetingSmartSummaryController. Otherwise the function returns nil.
Deprecated
Use ZoomSDKMeetingAICompanionController::getSmartSummaryHelper instead.

◆ getQueryHelper

- (ZoomSDKAICompanionQueryHelper *) getQueryHelper

Get object of ZoomSDKAICompanionQueryHelper.

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

◆ getSmartSummaryHelper

- (ZoomSDKAICompanionSmartSummaryHelper *) getSmartSummaryHelper

Get the smart summary controller.

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

◆ isTurnoffAllAICompanionsSupported

- (BOOL) isTurnoffAllAICompanionsSupported

Whether the meeting supports turning off the AI Companion features.

Returns
YES means the meeting can support turning off the AI Companion features. Otherwise the value is NO.

◆ isTurnOnAllAICompanionSupported

- (BOOL) isTurnOnAllAICompanionSupported

Whether the meeting supports turning on the AI Companion features.

Returns
YES means the meeting does support turn on the AI Companion features. Otherwise the value is NO.

◆ requestTurnoffAllAICompanion

- (ZoomSDKError) requestTurnoffAllAICompanion

Request host to turn off all started AI Companion features.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed, for more details, see ZoomSDKError.
Note
All AI features include ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartRecording can be turned off at once.

◆ requestTurnOnAllAICompanion

- (ZoomSDKError) requestTurnOnAllAICompanion

Ask the host to turn on all AI Companion features if they are enabled for the current meeting.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed, for more details, see ZoomSDKError.
Note
Only ZoomSDKAICompanionFeature:ZoomSDKAICompanionFeature#ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.

◆ turnOffAllAICompanion:

- (ZoomSDKError) turnOffAllAICompanion: (BOOL) deleteMeetingAssets

Turn off the AI Companion features.

Parameters
deleteMeetingAssetsYES whether delete the meeting assets when turn off the AI Companion features.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed, for more details, see ZoomSDKError.
Note
All AI features including ZoomSDKAICompanionFeature can be turned off at once.

◆ turnOnAllAICompanion

- (ZoomSDKError) turnOnAllAICompanion

Turn on all the AI Companion features. Only ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query and ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed, for more details, see ZoomSDKError.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingAICompanionControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 90 of file ZoomSDKMeetingAICompanionController.h.