IRecordingSettingContext Class Reference

Recording setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetRecordingPath (const zchar_t *szPath)=0
	Set the path to save the recording file.
virtual const zchar_t *	GetRecordingPath ()=0
	Get the path to save the recording file.
virtual SDKError	SetRecordingSettingEvent (IRecordingSettingContextEvent *pEvent)=0
	Set the event of recording settings.
virtual bool	CanGetCloudRecordingStorageInfo ()=0
	Check if the user has the privilege to get the storage information for cloud recording.
virtual SDKError	GetCloudRecordingStorageInfo ()=0
	Get the storage information of cloud recording.
virtual const zchar_t *	GetRecordingManagementURL ()=0
	Get the recording management URL. It returns the real url only after you retrieve the callback IRecordingSettingContextEvent.onCloudRecordingStorageInfo().
virtual SDKError	CanGetRecordingManagementURL (bool &bEnable)=0
	Set 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
	Determine if multi-audio stream recording is enabled.
virtual SDKError	EnableAddTimestampWatermark (bool bEnable)=0
	Enable/Disable watermark of timestamp.
virtual bool	IsAddTimestampWatermarkEnabled ()=0
	Determine 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
	Determine 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
	Determine 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
	Determine if placing video next to the shared content in recording file is enabled.

Detailed Description

Recording setting interface.

Definition at line 1251 of file setting_service_interface.h.

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]

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

EnableAddTimestampWatermark()

virtual SDKError IRecordingSettingContext::EnableAddTimestampWatermark ( bool bEnable )

pure virtual

Enable/Disable watermark of timestamp.

Parameters

bEnable

TRUE 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

bEnable

TRUE 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

bEnable

TRUE 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

bEnable

TRUE 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.

EnableShowVideoThumbnailWhenShare()

virtual SDKError IRecordingSettingContext::EnableShowVideoThumbnailWhenShare ( bool bEnable )

pure virtual

Enable/Disable showing the video thumbnail when sharing.

Parameters

bEnable

TRUE 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 zchar_t * IRecordingSettingContext::GetRecordingManagementURL ( )

pure virtual

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

Returns

TRUE indicates enabled. FALSE not.

GetRecordingPath()

virtual const zchar_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.

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 zchar_t * szPath )

pure virtual

Set the path to save the recording file.

Parameters

szPath

Specify 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

pEvent

The 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.