Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
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
 Sets the smart summary callback event handler.
 
virtual bool IsSmartSummarySupported ()=0
 Determines if current meeting support smart summary feature.
 
virtual bool IsSmartSummaryEnabled ()=0
 Determines 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
 Enables 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
 Starts smart summary.
 
virtual SDKError StopSmartSummary ()=0
 Stops 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 374 of file meeting_ai_companion_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingSmartSummaryHelper()

virtual IMeetingSmartSummaryHelper::~IMeetingSmartSummaryHelper ( )
inlinevirtual

Definition at line 377 of file meeting_ai_companion_interface.h.

377{}

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

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

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

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

◆ EnableSmartSummaryFeature()

virtual SDKError IMeetingSmartSummaryHelper::EnableSmartSummaryFeature ( )
pure virtual

Enables the smart summary feature for the account.

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

◆ IsSmartSummaryEnabled()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummaryEnabled ( )
pure virtual

Determines if smart summary feature is enabled in the meeting.

Returns
true if the smart summary feature is enabled. Otherwise, false.

◆ IsSmartSummaryStarted()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummaryStarted ( )
pure virtual

Query whether smart summary is started.

Returns
true if smart summary is started. Otherwise, false.

◆ IsSmartSummarySupported()

virtual bool IMeetingSmartSummaryHelper::IsSmartSummarySupported ( )
pure virtual

Determines if current meeting support smart summary feature.

Returns
true if the current meeting supports the smart summary feature. Otherwise, false.

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

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

◆ SetEvent()

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

Sets 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

Starts smart summary.

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

◆ StopSmartSummary()

virtual SDKError IMeetingSmartSummaryHelper::StopSmartSummary ( )
pure virtual

Stops smart summary.

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