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
	Get the smart summary helper.
virtual IMeetingAICompanionSmartSummaryHelper *	GetMeetingAICompanionSmartSummaryHelper ()=0
	Get the AI companion smart summary helper.
virtual IMeetingAICompanionQueryHelper *	GetMeetingAICompanionQueryHelper ()=0
	Get the AI companion query helper.
virtual bool	IsTurnoffAllAICompanionsSupported ()=0
virtual bool	IsTurnOnAllAICompanionsSupported ()=0
virtual bool	CanTurnOffAllAICompanions ()=0
	Determine whether the current user can turn off the AI Companion features.
virtual bool	CanTurnOnAllAICompanions ()=0
	Determine whether the current user can turn on the AI Companion features.
virtual SDKError	TurnOffAllAICompanions (bool bDeleteAssets)=0
	Turn off the AI Companion features. \All AI features including smart summary, smart recording and query can be turned off at once.
virtual SDKError	TurnOnAllAICompanions ()=0
	Turn on the AI Companion features. \Only smart summary and query can be turned on at once.
virtual bool	CanRequestTurnoffAllAICompanions ()=0
	Determine whether the current user can request host to turn off all started AI Companion features. \Notices: 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.
virtual bool	CanRequestTurnOnAllAICompanions ()=0
	Determine whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting. \Only smart summary and query can be requested to turn on at once.
virtual SDKError	RequestTurnoffAllAICompanions ()=0
	request host to turn off all started AI Companion features. \All AI features include smart summary, smart recording and query can be requested to turn off at once.
virtual SDKError	RequestTurnOnAllAICompanions ()=0
	request host to turn on all AI Companion features if they are enabled for the current meeting. \Only smart summary and query can be requested to turn on at once.

Detailed Description

Meeting AI Companion controller interface.

Definition at line 707 of file meeting_ai_companion_interface.h.

Member Function Documentation

CanRequestTurnoffAllAICompanions()

virtual bool IMeetingAICompanionController::CanRequestTurnoffAllAICompanions ( )

pure virtual

Determine whether the current user can request host to turn off all started AI Companion features. \Notices: 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 indicates the user can request host to turn off all started AI Companion features.

CanRequestTurnOnAllAICompanions()

virtual bool IMeetingAICompanionController::CanRequestTurnOnAllAICompanions ( )

pure virtual

Determine whether the current user can request host to turn on all AI Companion features if they are enabled for the current meeting. \Only smart summary and query can be requested to turn on at once.

Returns

True indicates the user can request host to turn on the AI Companion features.

CanTurnOffAllAICompanions()

virtual bool IMeetingAICompanionController::CanTurnOffAllAICompanions ( )

pure virtual

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

Returns

True indicates the user can turn off the AI Companion features.

CanTurnOnAllAICompanions()

virtual bool IMeetingAICompanionController::CanTurnOnAllAICompanions ( )

pure virtual

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

Returns

True indicates the user can turn on the AI Companion features.

GetMeetingAICompanionQueryHelper()

virtual IMeetingAICompanionQueryHelper * IMeetingAICompanionController::GetMeetingAICompanionQueryHelper ( )

pure virtual

Get 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

Get 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

Get 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, and is replaced by GetMeetingAICompanionSmartSummaryHelper().

IsTurnoffAllAICompanionsSupported()

virtual bool IMeetingAICompanionController::IsTurnoffAllAICompanionsSupported ( )

pure virtual

Returns

True indicates to support.

IsTurnOnAllAICompanionsSupported()

virtual bool IMeetingAICompanionController::IsTurnOnAllAICompanionsSupported ( )

pure virtual

Returns

True indicates to support.

RequestTurnoffAllAICompanions()

virtual SDKError IMeetingAICompanionController::RequestTurnoffAllAICompanions ( )

pure virtual

request host to turn off all started AI Companion features. \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 the function fails. To get extended error information, see SDKError enum.

RequestTurnOnAllAICompanions()

virtual SDKError IMeetingAICompanionController::RequestTurnOnAllAICompanions ( )

pure virtual

request host to turn on all AI Companion features if they are enabled for the current meeting. \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 the function fails. To get extended error information, see SDKError enum.

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. For more details, see IMeetingAICompanionCtrlEvent.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.

Remarks

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. \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 the function fails. To get extended error information, see SDKError enum.

TurnOnAllAICompanions()

virtual SDKError IMeetingAICompanionController::TurnOnAllAICompanions ( )

pure virtual

Turn on the AI Companion features. \Only smart summary and query can be turned on at once.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise the function fails. To get extended error information, see SDKError enum.