AI Companion feature control class. More...

#include <ZoomSDKMeetingAICompanionController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKMeetingSmartSummaryController *)	- getInMeetingSmartSummaryController
	Gets the smart summary controller.
(ZoomSDKAICompanionSmartSummaryHelper *)	- getSmartSummaryHelper
	Gets the smart summary controller.
(ZoomSDKAICompanionQueryHelper *)	- getQueryHelper
	Gets 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< ZoomSDKMeetingAICompanionControllerDelegate >	delegate
	Delegate to receive AI Companion feature callbacks.

Detailed Description

AI Companion feature control class.

Definition at line 115 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 if the user can request host to turn off the AI Companion features. Otherwise, NO.

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

References canRequestTurnoffAllAICompanion.

Referenced by canRequestTurnoffAllAICompanion.

◆ 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 if the user can ask the host to turn on the AI Companion features. Otherwise, NO.

Note: Only ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.

References canRequestTurnOnAllAICompanion.

Referenced by canRequestTurnOnAllAICompanion.

◆ canTurnOffAllAICompanions

- (BOOL) canTurnOffAllAICompanions

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

Returns: YES if the user can turn off the AI Companion features. Otherwise, NO.

References canTurnOffAllAICompanions.

Referenced by canTurnOffAllAICompanions.

◆ canTurnOnAllAICompanion

- (BOOL) canTurnOnAllAICompanion

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

Returns: YES if the user can turn off the AI Companion features. Otherwise, NO.

References canTurnOnAllAICompanion.

Referenced by canTurnOnAllAICompanion.

◆ getInMeetingSmartSummaryController

- (ZoomSDKMeetingSmartSummaryController *) getInMeetingSmartSummaryController

Gets the smart summary controller.

Returns: If the function succeeds, it returns a pointer to ZoomSDKMeetingSmartSummaryController. Otherwise, this function fails and returns nil.

Deprecated: Use ZoomSDKMeetingAICompanionController::getSmartSummaryHelper instead.

References getInMeetingSmartSummaryController, and getSmartSummaryHelper.

Referenced by getInMeetingSmartSummaryController.

◆ getQueryHelper

- (ZoomSDKAICompanionQueryHelper *) getQueryHelper

Gets object of ZoomSDKAICompanionQueryHelper.

Returns: If the function succeeds, it returns a ZoomSDKAICompanionQueryHelper object. Otherwise, this function fails and returns nil.

References getQueryHelper.

Referenced by getQueryHelper.

◆ getSmartSummaryHelper

- (ZoomSDKAICompanionSmartSummaryHelper *) getSmartSummaryHelper

Gets the smart summary controller.

Returns: If the function succeeds, it returns a pointer to ZoomSDKAICompanionSmartSummaryHelper. Otherwise, this function fails and returns nil.

References getSmartSummaryHelper.

Referenced by getInMeetingSmartSummaryController, and getSmartSummaryHelper.

◆ isTurnoffAllAICompanionsSupported

- (BOOL) isTurnoffAllAICompanionsSupported

Whether the meeting supports turning off the AI Companion features.

Returns: YES if the meeting can support turning off the AI Companion features. Otherwise, NO.

References isTurnoffAllAICompanionsSupported.

Referenced by isTurnoffAllAICompanionsSupported.

◆ isTurnOnAllAICompanionSupported

- (BOOL) isTurnOnAllAICompanionSupported

Whether the meeting supports turning on the AI Companion features.

Returns: YES if the meeting does support turn on the AI Companion features. Otherwise, NO.

References isTurnOnAllAICompanionSupported.

Referenced by isTurnOnAllAICompanionSupported.

◆ requestTurnoffAllAICompanion

- (ZoomSDKError) requestTurnoffAllAICompanion

Request host to turn off all started AI Companion features.

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

Note: All AI features include ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartRecording can be turned off at once.

References requestTurnoffAllAICompanion.

Referenced by requestTurnoffAllAICompanion.

◆ 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: Only ZoomSDKAICompanionFeature:ZoomSDKAICompanionFeature#ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature::ZoomSDKAICompanionFeature_SmartSummary can be turned on at once.

References requestTurnOnAllAICompanion.

Referenced by requestTurnOnAllAICompanion.

◆ turnOffAllAICompanion:

- (ZoomSDKError) turnOffAllAICompanion: (BOOL) deleteMeetingAssets

Turn off the AI Companion features.

Parameters

deleteMeetingAssets YES whether delete the meeting assets when turn off the AI Companion features, NO otherwise.

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

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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

References turnOnAllAICompanion.

Referenced by turnOnAllAICompanion.

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingAICompanionControllerDelegate>) delegate

readwritenonatomicassign

Delegate to receive AI Companion feature callbacks.

Definition at line 120 of file ZoomSDKMeetingAICompanionController.h.

Instance Methods

Properties