Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
Public Member Functions
IRecordingSettingContext Class Referenceabstract

Recording setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual SDKError SetRecordingPath (const zchar_t *szPath)=0
 Sets the path to save the recording file.
 
virtual const zchar_t * GetRecordingPath ()=0
 Gets the path to save the recording file.
 
virtual SDKError SetRecordingSettingEvent (IRecordingSettingContextEvent *pEvent)=0
 Sets the event of recording settings.
 
virtual bool CanGetCloudRecordingStorageInfo ()=0
 Checks if the user has the privilege to get the storage information for cloud recording.
 
virtual SDKError GetCloudRecordingStorageInfo ()=0
 Gets the storage information of cloud recording.
 
virtual const zchar_t * GetRecordingManagementURL ()=0
 Gets the recording management URL. It returns the real url only after you retrieve the callback IRecordingSettingContextEvent.onCloudRecordingStorageInfo().
 
virtual SDKError CanGetRecordingManagementURL (bool &bEnable)=0
 Sets if it is able to get recording management URL.
 
virtual SDKError EnableMultiAudioStreamRecord (bool bEnable)=0
 Enable/Disable multi-audio stream recording.
 
virtual bool IsMultiAudioStreamRecordEnabled ()=0
 Determines if multi-audio stream recording is enabled.
 
virtual SDKError EnableAddTimestampWatermark (bool bEnable)=0
 Enable/Disable watermark of timestamp.
 
virtual bool IsAddTimestampWatermarkEnabled ()=0
 Determines if the watermark of timestamps is enabled.
 
virtual SDKError EnableOptimizeFor3rdPartyVideoEditor (bool bEnable)=0
 Enable/Disable the optimization for the third party video editor.
 
virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled ()=0
 Determines if the third party video editor is enabled.
 
virtual SDKError EnableShowVideoThumbnailWhenShare (bool bEnable)=0
 Enable/Disable showing the video thumbnail when sharing.
 
virtual bool IsShowVideoThumbnailWhenShareEnabled ()=0
 Determines if video thumbnail is enabled when sharing.
 
virtual SDKError EnablePlaceVideoNextToShareInRecord (bool bEnable)=0
 Enable/Disable placing the video layout next to the shared content in recording file.
 
virtual bool IsPlaceVideoNextToShareInRecordEnabled ()=0
 Determines if placing video next to the shared content in recording file is enabled.
 

Detailed Description

Recording setting interface.

Definition at line 1650 of file setting_service_interface.h.

Member Function Documentation

◆ CanGetCloudRecordingStorageInfo()

virtual bool IRecordingSettingContext::CanGetCloudRecordingStorageInfo ( )
pure virtual

Checks if the user has the privilege to get the storage information for cloud recording.

Returns
true indicates the user has the privilege.

◆ CanGetRecordingManagementURL()

virtual SDKError IRecordingSettingContext::CanGetRecordingManagementURL ( bool & bEnable)
pure virtual

Sets if it is able to get recording management URL.

Parameters
[out]

true indicates the recording management URL can be retrieved. false not. It validates only when the return value is SDKERR_SUCCESS.

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

◆ EnableAddTimestampWatermark()

virtual SDKError IRecordingSettingContext::EnableAddTimestampWatermark ( bool bEnable)
pure virtual

Enable/Disable watermark of timestamp.

Parameters
bEnabletrue indicates enabled. false not.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableMultiAudioStreamRecord()

virtual SDKError IRecordingSettingContext::EnableMultiAudioStreamRecord ( bool bEnable)
pure virtual

Enable/Disable multi-audio stream recording.

Parameters
bEnabletrue indicates enabled. false not.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableOptimizeFor3rdPartyVideoEditor()

virtual SDKError IRecordingSettingContext::EnableOptimizeFor3rdPartyVideoEditor ( bool bEnable)
pure virtual

Enable/Disable the optimization for the third party video editor.

Parameters
bEnabletrue indicates enabled. false not.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnablePlaceVideoNextToShareInRecord()

virtual SDKError IRecordingSettingContext::EnablePlaceVideoNextToShareInRecord ( bool bEnable)
pure virtual

Enable/Disable placing the video layout next to the shared content in recording file.

Parameters
bEnabletrue indicates enabled. false not.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableShowVideoThumbnailWhenShare()

virtual SDKError IRecordingSettingContext::EnableShowVideoThumbnailWhenShare ( bool bEnable)
pure virtual

Enable/Disable showing the video thumbnail when sharing.

Parameters
bEnabletrue indicates enabled. false not.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetCloudRecordingStorageInfo()

virtual SDKError IRecordingSettingContext::GetCloudRecordingStorageInfo ( )
pure virtual

Gets the storage information of cloud recording.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.
Note
If the return value is SDKERR_SUCCESS, IRecordingSettingContextEvent.onCloudRecordingStorageInfo() will be triggered after the information has be retrieved.

◆ GetRecordingManagementURL()

virtual const zchar_t * IRecordingSettingContext::GetRecordingManagementURL ( )
pure virtual

Gets the recording management URL. It returns the real url only after you retrieve the callback IRecordingSettingContextEvent.onCloudRecordingStorageInfo().

Returns
The recording management URL.

◆ GetRecordingPath()

virtual const zchar_t * IRecordingSettingContext::GetRecordingPath ( )
pure virtual

Gets the path to save the recording file.

Returns
The path to save the recording file.

◆ IsAddTimestampWatermarkEnabled()

virtual bool IRecordingSettingContext::IsAddTimestampWatermarkEnabled ( )
pure virtual

Determines if the watermark of timestamps is enabled.

Returns
true indicates enabled.

◆ IsMultiAudioStreamRecordEnabled()

virtual bool IRecordingSettingContext::IsMultiAudioStreamRecordEnabled ( )
pure virtual

Determines if multi-audio stream recording is enabled.

Returns
true indicates enabled.

◆ IsOptimizeFor3rdPartyVideoEditorEnabled()

virtual bool IRecordingSettingContext::IsOptimizeFor3rdPartyVideoEditorEnabled ( )
pure virtual

Determines if the third party video editor is enabled.

Returns
true indicates enabled.

◆ IsPlaceVideoNextToShareInRecordEnabled()

virtual bool IRecordingSettingContext::IsPlaceVideoNextToShareInRecordEnabled ( )
pure virtual

Determines if placing video next to the shared content in recording file is enabled.

Returns
true indicates enabled.

◆ IsShowVideoThumbnailWhenShareEnabled()

virtual bool IRecordingSettingContext::IsShowVideoThumbnailWhenShareEnabled ( )
pure virtual

Determines if video thumbnail is enabled when sharing.

Returns
true indicates enabled.

◆ SetRecordingPath()

virtual SDKError IRecordingSettingContext::SetRecordingPath ( const zchar_t * szPath)
pure virtual

Sets the path to save the recording file.

Parameters
szPathSpecify the path to save the recording file.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetRecordingSettingEvent()

virtual SDKError IRecordingSettingContext::SetRecordingSettingEvent ( IRecordingSettingContextEvent * pEvent)
pure virtual

Sets the event of recording settings.

Parameters
pEventThe event of recording settings.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.