Meeting recording controller interface. More...

#include <meeting_recording_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingRecordingCtrlEvent *pEvent)=0
	Set meeting recording callback event handler. More...

virtual SDKError	StartRecording (time_t &startTimestamp, wchar_t *recPath)=0
	Start recording. More...

virtual SDKError	StopRecording (time_t &stopTimestamp)=0
	Stop recording. More...

virtual SDKError	CanStartRecording (bool cloud_recording, unsigned int userid)=0
	Determine if the specified user is enabled to start recording. More...

virtual SDKError	CanAllowDisAllowLocalRecording ()=0
	Determine if the current user own the authority to change the recording permission of the others. More...

virtual SDKError	StartCloudRecording ()=0
	Start cloud recording. More...

virtual SDKError	StopCloudRecording ()=0
	Stop cloud recording. More...

virtual SDKError	IsSupportLocalRecording (unsigned int userid)=0
	Determine if the user owns the authority to enable the local recording. More...

virtual SDKError	AllowLocalRecording (unsigned int userid)=0
	Give the specified user authority for local recording. More...

virtual SDKError	DisAllowLocalRecording (unsigned int userid)=0
	Abrogate the authority of the specified user for local recoding. More...

virtual SDKError	RequestCustomizedLocalRecordingSource ()=0
	Send a request to enable the SDK to call IMeetingRecordingCtrlEvent::onCustomizedLocalRecordingSourceNotification(). More...

virtual SDKError	PauseRecording ()=0
	Pause recording. More...

virtual SDKError	ResumeRecording ()=0
	Resume recording. More...

virtual SDKError	PauseCloudRecording ()=0
	Pause cloud recording. More...

virtual SDKError	ResumeCloudRecording ()=0
	Resume cloud recording. More...

Detailed Description

Meeting recording controller interface.

Member Function Documentation

◆ AllowLocalRecording()

virtual SDKError IMeetingRecordingController::AllowLocalRecording ( unsigned int userid )

pure virtual

Give the specified user authority for local recording.

Parameters

userid Specifies the user ID.

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

◆ CanAllowDisAllowLocalRecording()

virtual SDKError IMeetingRecordingController::CanAllowDisAllowLocalRecording ( )

pure virtual

Determine if the current user own the authority to change the recording permission of the others.

Returns: If the user own the authority, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CanStartRecording()

virtual SDKError IMeetingRecordingController::CanStartRecording	(	bool	cloud_recording,
		unsigned int	userid
	)

pure virtual

Determine if the specified user is enabled to start recording.

Parameters

cloud_recording	TRUE indicates to determine whether to enable the cloud recording. FALSE local recording.
userid	Specifies the user ID.

Returns: If the value of cloud_recording is set to TRUE and the cloud recording is enabled, the return value is SDKErr_Success. If the value of cloud_recording is set to FALSE and the local recording is enabled, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ DisAllowLocalRecording()

virtual SDKError IMeetingRecordingController::DisAllowLocalRecording ( unsigned int userid )

pure virtual

Abrogate the authority of the specified user for local recoding.

Parameters

userid Specifies the user ID.

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

◆ IsSupportLocalRecording()

virtual SDKError IMeetingRecordingController::IsSupportLocalRecording ( unsigned int userid )

pure virtual

Determine if the user owns the authority to enable the local recording.

Parameters

userid Specifies the user ID.

Returns: If the specified user is enabled to start local recording, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ PauseCloudRecording()

virtual SDKError IMeetingRecordingController::PauseCloudRecording ( )

pure virtual

Pause cloud recording.

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

◆ PauseRecording()

virtual SDKError IMeetingRecordingController::PauseRecording ( )

pure virtual

Pause recording.

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

◆ RequestCustomizedLocalRecordingSource()

virtual SDKError IMeetingRecordingController::RequestCustomizedLocalRecordingSource ( )

pure virtual

Send a request to enable the SDK to call IMeetingRecordingCtrlEvent::onCustomizedLocalRecordingSourceNotification().

Returns: If the function succeeds, the return value is SDKErr_Success, and you will receive the onCustomizedLocalRecordingSourcenNotification callback event. Otherwise failed. To get extended error information, see SDKError enum.

Remarks: Valid only for custom style user interface mode only when recording.

◆ ResumeCloudRecording()

virtual SDKError IMeetingRecordingController::ResumeCloudRecording ( )

pure virtual

Resume cloud recording.

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

◆ ResumeRecording()

virtual SDKError IMeetingRecordingController::ResumeRecording ( )

pure virtual

Resume recording.

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

◆ SetEvent()

virtual SDKError IMeetingRecordingController::SetEvent ( IMeetingRecordingCtrlEvent * pEvent )

pure virtual

Set meeting recording callback event handler.

Parameters

pEvent A pointer to the IMeetingRecordingCtrlEvent that receives the recording event.

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

◆ StartCloudRecording()

virtual SDKError IMeetingRecordingController::StartCloudRecording ( )

pure virtual

Start cloud recording.

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

◆ StartRecording()

virtual SDKError IMeetingRecordingController::StartRecording	(	time_t &	startTimestamp,
		wchar_t *	recPath
	)

pure virtual

Start recording.

Parameters

[out]	startTimestamp	The timestamps when start recording.
	recPath	Specifies the path of saving the recording. The SDK will try to create this path if the specified one does not exist. If the creation failed, an error code SDKERR_INVALID_PARAMETER returns.

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

◆ StopCloudRecording()

virtual SDKError IMeetingRecordingController::StopCloudRecording ( )

pure virtual

Stop cloud recording.

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

◆ StopRecording()

virtual SDKError IMeetingRecordingController::StopRecording ( time_t & stopTimestamp )

pure virtual

Stop recording.

Parameters

[out] stopTimestamp The timestamps when stop recording.

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:

h/meeting_service_components/meeting_recording_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AllowLocalRecording()

◆ CanAllowDisAllowLocalRecording()

◆ CanStartRecording()

◆ DisAllowLocalRecording()

◆ IsSupportLocalRecording()

◆ PauseCloudRecording()

◆ PauseRecording()

◆ RequestCustomizedLocalRecordingSource()

◆ ResumeCloudRecording()

◆ ResumeRecording()

◆ SetEvent()

◆ StartCloudRecording()

◆ StartRecording()

◆ StopCloudRecording()

◆ StopRecording()