ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IRecordingSettingContext Class Referenceabstract

Recording setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual SDKError SetRecordingPath (const wchar_t *szPath)=0
 Set the path to save the recording file. More...
 
virtual const wchar_t * GetRecordingPath ()=0
 Get the path to save the recording file. More...
 
virtual SDKError SetRecordingSettingEvent (IRecordingSettingContextEvent *pEvent)=0
 Set the event of recording settings. More...
 
virtual bool CanGetCloudRecordingStorageInfo ()=0
 Check if the user has the privilege to get the storage information for cloud recording. More...
 
virtual SDKError GetCloudRecordingStorageInfo ()=0
 Get the storage information of cloud recording. More...
 
virtual const wchar_t * GetRecordingManagementURL ()=0
 Get the recording management URL. More...
 
virtual SDKError CanGetRecordingManagementURL (bool &bEnable)=0
 Set if it is able to get recording management URL. More...
 
virtual SDKError EnableSelectRecordFileLocationAfterMeeting (bool bEnable)=0
 Set whether to enable the function of selecting the path to save the recording file after meeting. More...
 
virtual bool IsSelectRecordFileLocationAfterMeetingEnabled ()=0
 Check if the function of selecting storage path for recording file is enabled. More...
 
virtual SDKError EnableMultiAudioStreamRecord (bool bEnable)=0
 Enable/Disable multi-audio stream recording. More...
 
virtual bool IsMultiAudioStreamRecordEnabled ()=0
 Determine if multi-audio stream recording is enabled. More...
 
virtual SDKError EnableAddTimestampWatermark (bool bEnable)=0
 Enable/Disable watermark of timestamp. More...
 
virtual bool IsAddTimestampWatermarkEnabled ()=0
 Determine if the watermark of timestamps is enabled. More...
 
virtual SDKError EnableOptimizeFor3rdPartyVideoEditor (bool bEnable)=0
 Enable/Disable the optimization for the third party video editor. More...
 
virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled ()=0
 Determine if the third party video editor is enabled. More...
 
virtual SDKError EnableShowVideoThumbnailWhenShare (bool bEnable)=0
 Enable/Disable showing the video thumbnail when sharing. More...
 
virtual bool IsShowVideoThumbnailWhenShareEnabled ()=0
 Determine if video thumbnail is enabled when sharing. More...
 
virtual SDKError EnablePlaceVideoNextToShareInRecord (bool bEnable)=0
 Enable/Disable placing the video layout next to the shared content in recording file. More...
 
virtual bool IsPlaceVideoNextToShareInRecordEnabled ()=0
 Determine if placing video next to the shared content in recording file is enabled. More...
 

Detailed Description

Recording setting interface.

Member Function Documentation

◆ CanGetCloudRecordingStorageInfo()

virtual bool IRecordingSettingContext::CanGetCloudRecordingStorageInfo ( )
pure virtual

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

Returns
TRUE indicates the user has the privilege. FALSE not.

◆ CanGetRecordingManagementURL()

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

Set if it is able to get recording management URL.

Parameters
[out]

◆ 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 failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ EnableSelectRecordFileLocationAfterMeeting()

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

Set whether to enable the function of selecting the path to save the recording file after meeting.

Parameters
bEnableTRUE means to enable, FALSE not.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ GetCloudRecordingStorageInfo()

virtual SDKError IRecordingSettingContext::GetCloudRecordingStorageInfo ( )
pure virtual

Get the storage information of cloud recording.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum. If the return value is SDKErr_Success, IRecordingSettingContextEvent.onCloudRecordingStorageInfo() will be triggered after the infermation has be retrieved.

◆ GetRecordingManagementURL()

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

Get the recording management URL.

Returns
TRUE indicates enabled. FALSE not.

◆ GetRecordingPath()

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

Get the path to save the recording file.

Returns
The path to save the recording file.

◆ IsAddTimestampWatermarkEnabled()

virtual bool IRecordingSettingContext::IsAddTimestampWatermarkEnabled ( )
pure virtual

Determine if the watermark of timestamps is enabled.

Returns
TRUE indicates enabled. FALSE not.

◆ IsMultiAudioStreamRecordEnabled()

virtual bool IRecordingSettingContext::IsMultiAudioStreamRecordEnabled ( )
pure virtual

Determine if multi-audio stream recording is enabled.

Returns
TRUE indicates enabled. FALSE not.

◆ IsOptimizeFor3rdPartyVideoEditorEnabled()

virtual bool IRecordingSettingContext::IsOptimizeFor3rdPartyVideoEditorEnabled ( )
pure virtual

Determine if the third party video editor is enabled.

Returns
TRUE indicates enabled. FALSE not.

◆ IsPlaceVideoNextToShareInRecordEnabled()

virtual bool IRecordingSettingContext::IsPlaceVideoNextToShareInRecordEnabled ( )
pure virtual

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

Returns
TRUE indicates enabled. FALSE not.

◆ IsSelectRecordFileLocationAfterMeetingEnabled()

virtual bool IRecordingSettingContext::IsSelectRecordFileLocationAfterMeetingEnabled ( )
pure virtual

Check if the function of selecting storage path for recording file is enabled.

Returns
TRUE indicates enabled. FALSE not.

◆ IsShowVideoThumbnailWhenShareEnabled()

virtual bool IRecordingSettingContext::IsShowVideoThumbnailWhenShareEnabled ( )
pure virtual

Determine if video thumbnail is enabled when sharing.

Returns
TRUE indicates enabled. FALSE not.

◆ SetRecordingPath()

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

Set 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 failed. To get extended error information, see SDKError enum.

◆ SetRecordingSettingEvent()

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

Set the event of recording settings.

Parameters
pEventThe event of recording settings.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file: