Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IMeetingSmartSummaryHelper Class Referenceabstract

Meeting smart summary helper interface. More...

#include <meeting_ai_companion_interface.h>

Inherited by IMeetingSmartSummaryController.

Public Member Functions

virtual ~IMeetingSmartSummaryHelper ()
 
virtual void SetEvent (IMeetingSmartSummaryHelperEvent *event)=0
 Set the smart summary callback event handler.
 
virtual bool IsSmartSummarySupported ()=0
 Determine if current meeting support smart summary feature.
 
virtual bool IsSmartSummaryEnabled ()=0
 Determine if smart summary feature is enabled in the meeting.
 
virtual SDKError CanEnableSmartSummaryFeature ()=0
 Whether the current user can enable the smart summary feature for the account.
 
virtual SDKError EnableSmartSummaryFeature ()=0
 Enable the smart summary feature for the account.
 
virtual SDKError CanStartSmartSummary ()=0
 Whether the current user is able to start smart summary.
 
virtual SDKError StartSmartSummary ()=0
 Start smart summary.
 
virtual SDKError StopSmartSummary ()=0
 Stop smart summary.
 
virtual bool IsSmartSummaryStarted ()=0
 Query whether smart summary is started.
 
virtual SDKError CanRequestEnableSmartSummaryFeature ()=0
 Whether the current user can request the admin to enable the smart summary feature for the account.
 
virtual SDKError RequestEnableSmartSummaryFeature ()=0
 Request the admin to enable the smart summary feature for the account.
 
virtual SDKError CanRequestStartSmartSummary ()=0
 Whether the current user can request host to start the smart summary for the current meeting.
 
virtual SDKError RequestStartSmartSummary ()=0
 Request the host to start the smart summary for the current meeting.
 

Detailed Description

Meeting smart summary helper interface.

Deprecated
This class is marked as deprecated

Definition at line 278 of file meeting_ai_companion_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingSmartSummaryHelper()

virtual IMeetingSmartSummaryHelper::~IMeetingSmartSummaryHelper ( )
inlinevirtual

Definition at line 281 of file meeting_ai_companion_interface.h.

281{}

Member Function Documentation

◆ CanEnableSmartSummaryFeature()

virtual SDKError IMeetingSmartSummaryHelper::CanEnableSmartSummaryFeature ( )
pure virtual

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

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

◆ CanRequestEnableSmartSummaryFeature()

virtual SDKError IMeetingSmartSummaryHelper::CanRequestEnableSmartSummaryFeature ( )
pure virtual

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

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

◆ CanRequestStartSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::CanRequestStartSmartSummary ( )
pure virtual

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

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

◆ CanStartSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::CanStartSmartSummary ( )
pure virtual

Whether the current user is able to start smart summary.

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

◆ EnableSmartSummaryFeature()

virtual SDKError IMeetingSmartSummaryHelper::EnableSmartSummaryFeature ( )
pure virtual

Enable the smart summary feature for the account.

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

◆ IsSmartSummaryEnabled()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummaryEnabled ( )
pure virtual

Determine if smart summary feature is enabled in the meeting.

Returns
True means smart summary feature is enabled.

◆ IsSmartSummaryStarted()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummaryStarted ( )
pure virtual

Query whether smart summary is started.

Returns
True means smart summary is started, false means not.

◆ IsSmartSummarySupported()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummarySupported ( )
pure virtual

Determine if current meeting support smart summary feature.

Returns
True means the current meeting support smart summary feature, False means not supported.

◆ RequestEnableSmartSummaryFeature()

virtual SDKError IMeetingSmartSummaryHelper::RequestEnableSmartSummaryFeature ( )
pure virtual

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

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

◆ RequestStartSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::RequestStartSmartSummary ( )
pure virtual

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

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

◆ SetEvent()

virtual void IMeetingSmartSummaryHelper::SetEvent ( IMeetingSmartSummaryHelperEvent * event)
pure virtual

Set the smart summary callback event handler.

Parameters
eventA pointer to the IMeetingSmartSummaryHelperEvent that receives the smart summary event.

◆ StartSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::StartSmartSummary ( )
pure virtual

Start smart summary.

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

◆ StopSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::StopSmartSummary ( )
pure virtual

Stop smart summary.

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