IMeetingAICompanionController Class Reference

Meeting AI Companion controller interface. More...

#include <meeting_ai_companion_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingAICompanionCtrlEvent *pEvent)=0
	Configure the meeting AI companion controller callback event handler.
virtual IMeetingSmartSummaryHelper *	GetMeetingSmartSummaryHelper ()=0
	Gets the smart summary helper.
virtual IMeetingAICompanionSmartSummaryHelper *	GetMeetingAICompanionSmartSummaryHelper ()=0
	Gets the AI companion smart summary helper.
virtual IMeetingAICompanionQueryHelper *	GetMeetingAICompanionQueryHelper ()=0
	Gets the AI companion query helper.
virtual bool	IsTurnoffAllAICompanionsSupported ()=0
	Determines whether the current meeting supports turning off the AI Companion features.
virtual bool	IsTurnOnAllAICompanionsSupported ()=0
	Determines whether the current meeting supports turning on the AI Companion features.
virtual bool	CanTurnOffAllAICompanions ()=0
	Determines whether the current user can turn off the AI Companion features.
virtual bool	CanTurnOnAllAICompanions ()=0
	Determines whether the current user can turn on the AI Companion features.
virtual SDKError	TurnOffAllAICompanions (bool bDeleteAssets)=0
	Turn off the AI Companion features.
virtual SDKError	TurnOnAllAICompanions ()=0
	Turn on the AI Companion features.
virtual bool	CanRequestTurnoffAllAICompanions ()=0
	Determines whether the current user can request host to turn off all started AI Companion features.
virtual bool	CanRequestTurnOnAllAICompanions ()=0
	Determines whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting.
virtual SDKError	RequestTurnoffAllAICompanions ()=0
	request host to turn off all started AI Companion features.
virtual SDKError	RequestTurnOnAllAICompanions ()=0
	request host to turn on all AI Companion features if they are enabled for the current meeting.

Detailed Description

Meeting AI Companion controller interface.

Definition at line 959 of file meeting_ai_companion_interface.h.

Member Function Documentation

CanRequestTurnoffAllAICompanions()

virtual bool IMeetingAICompanionController::CanRequestTurnoffAllAICompanions ( )

pure virtual

Determines whether the current user can request host to turn off all started AI Companion features.

Note

if the current user join the meeting before the host, they can check CanTurnOffAllAICompanions to turn off the AI Companion features by himself/herself. All AI features include smart summary, smart recording and query can be requested to turn off at once.

Returns

true if the user can request host to turn off all started AI Companion features. Otherwise, false.

CanRequestTurnOnAllAICompanions()

virtual bool IMeetingAICompanionController::CanRequestTurnOnAllAICompanions ( )

pure virtual

Determines whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting.

Note

smart summary and query can be requested to turn on at once.

Returns

true if the user can request host to turn on the AI Companion features. Otherwise, false.

CanTurnOffAllAICompanions()

virtual bool IMeetingAICompanionController::CanTurnOffAllAICompanions ( )

pure virtual

Determines whether the current user can turn off the AI Companion features.

Returns

true if the user can turn off the AI Companion features. Otherwise, false.

CanTurnOnAllAICompanions()

virtual bool IMeetingAICompanionController::CanTurnOnAllAICompanions ( )

pure virtual

Determines whether the current user can turn on the AI Companion features.

Returns

true if the user can turn on the AI Companion features. Otherwise, false.

GetMeetingAICompanionQueryHelper()

virtual IMeetingAICompanionQueryHelper * IMeetingAICompanionController::GetMeetingAICompanionQueryHelper ( )

pure virtual

Gets the AI companion query helper.

Returns

If the function succeeds, the return value is a pointer to IMeetingAICompanionQueryHelper. Otherwise the function returns nullptr.

GetMeetingAICompanionSmartSummaryHelper()

virtual IMeetingAICompanionSmartSummaryHelper * IMeetingAICompanionController::GetMeetingAICompanionSmartSummaryHelper ( )

pure virtual

Gets the AI companion smart summary helper.

Returns

If the function succeeds, the return value is a pointer to IMeetingAICompanionSmartSummaryHelper. Otherwise the function returns nullptr.

GetMeetingSmartSummaryHelper()

virtual IMeetingSmartSummaryHelper * IMeetingAICompanionController::GetMeetingSmartSummaryHelper ( )

pure virtual

Gets the smart summary helper.

Returns

If the function succeeds, the return value is a pointer to IMeetingSmartSummaryHelper. Otherwise the function returns nullptr.

Deprecated

This interface is marked as deprecated, Use GetMeetingAICompanionSmartSummaryHelper() instead.

IsTurnoffAllAICompanionsSupported()

virtual bool IMeetingAICompanionController::IsTurnoffAllAICompanionsSupported ( )

pure virtual

Determines whether the current meeting supports turning off the AI Companion features.

Returns

true if the current meeting supports turning off the AI Companion features. Otherwise, false.

IsTurnOnAllAICompanionsSupported()

virtual bool IMeetingAICompanionController::IsTurnOnAllAICompanionsSupported ( )

pure virtual

Determines whether the current meeting supports turning on the AI Companion features.

Returns

true if the current meeting supports turning on the AI Companion features. Otherwise, false.

RequestTurnoffAllAICompanions()

virtual SDKError IMeetingAICompanionController::RequestTurnoffAllAICompanions ( )

pure virtual

request host to turn off all started AI Companion features.

Note

All AI features include smart summary, smart recording and query can be requested to turn off at once.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

RequestTurnOnAllAICompanions()

virtual SDKError IMeetingAICompanionController::RequestTurnOnAllAICompanions ( )

pure virtual

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

Note

Only smart summary and query can be requested to turn on at once.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

SetEvent()

virtual SDKError IMeetingAICompanionController::SetEvent ( IMeetingAICompanionCtrlEvent * pEvent )

pure virtual

Configure the meeting AI companion controller callback event handler.

Parameters

pEvent

An object pointer to the IMeetingAICompanionCtrlEvent that receives the meeting AI companion callback event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note

The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

TurnOffAllAICompanions()

virtual SDKError IMeetingAICompanionController::TurnOffAllAICompanions ( bool bDeleteAssets )

pure virtual

Turn off the AI Companion features.

Note

All AI features including smart summary, smart recording and query can be turned off at once.

Parameters

deleteAssets

Specify whether delete the meeting assets when turn off the AI Companion features.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

TurnOnAllAICompanions()

virtual SDKError IMeetingAICompanionController::TurnOnAllAICompanions ( )

pure virtual

Turn on the AI Companion features.

Note

smart summary and query can be turned on at once.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.