Meeting recording controller interface. More...

#include <meeting_recording_interface.h>

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

virtual SDKError	IsSupportRequestLocalRecordingPrivilege ()=0
	Determines if the user owns the authority to enable the local recording.

virtual SDKError	RequestLocalRecordingPrivilege ()=0
	Sends a request to enable the SDK to start local recording.

virtual SDKError	RequestStartCloudRecording ()=0
	Sends a request to ask the host to start cloud recording.

virtual SDKError	StartRecording (time_t &startTimestamp)=0
	Starts recording.

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

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

virtual bool	IsSmartRecordingEnabled ()=0
	Determines if the smart recording feature is enabled in the meeting.

virtual bool	CanEnableSmartRecordingFeature ()=0
	Whether the current user can enable the smart recording feature.

virtual SDKError	EnableSmartRecording ()=0
	Enables the smart recording feature.

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

virtual SDKError	StartCloudRecording ()=0
	Starts cloud recording.

virtual SDKError	StopCloudRecording ()=0
	Stops cloud recording.

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

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

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

virtual SDKError	PauseRecording ()=0
	Pause recording.

virtual SDKError	ResumeRecording ()=0
	Resume recording.

virtual SDKError	PauseCloudRecording ()=0
	Pause cloud recording.

virtual SDKError	ResumeCloudRecording ()=0
	Resume cloud recording.

virtual SDKError	CanStartRawRecording ()=0
	Determines if the specified user is enabled to start raw recording.

virtual SDKError	StartRawRecording ()=0
	Starts rawdata recording.

virtual SDKError	StopRawRecording ()=0
	Stops rawdata recording.

virtual RecordingStatus	GetCloudRecordingStatus ()=0
	Gets current cloud recording.

Detailed Description

Meeting recording controller interface.

Definition at line 345 of file meeting_recording_interface.h.

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

◆ CanAllowDisAllowLocalRecording()

virtual SDKError IMeetingRecordingController::CanAllowDisAllowLocalRecording ( )

pure virtual

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

◆ CanEnableSmartRecordingFeature()

virtual bool IMeetingRecordingController::CanEnableSmartRecordingFeature ( )

pure virtual

Whether the current user can enable the smart recording feature.

Returns: true indicates the current user can enable the smart recording feature.

◆ CanStartRawRecording()

virtual SDKError IMeetingRecordingController::CanStartRawRecording ( )

pure virtual

Determines if the specified user is enabled to start raw recording.

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

◆ CanStartRecording()

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

pure virtual

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

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

◆ EnableSmartRecording()

virtual SDKError IMeetingRecordingController::EnableSmartRecording ( )

pure virtual

Enables the smart recording feature.

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

◆ GetCloudRecordingStatus()

virtual RecordingStatus IMeetingRecordingController::GetCloudRecordingStatus ( )

pure virtual

Gets current cloud recording.

Returns: If the function succeeds, it returns recording status.

◆ IsSmartRecordingEnabled()

virtual bool IMeetingRecordingController::IsSmartRecordingEnabled ( )

pure virtual

Determines if the smart recording feature is enabled in the meeting.

Returns: true indicates that the feature enabled, false means that the feature isn't enabled.

◆ IsSupportLocalRecording()

virtual SDKError IMeetingRecordingController::IsSupportLocalRecording ( unsigned int userid )

pure virtual

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

◆ IsSupportRequestLocalRecordingPrivilege()

virtual SDKError IMeetingRecordingController::IsSupportRequestLocalRecordingPrivilege ( )

pure virtual

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

Returns: If the host is enabled to handle local recording request, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ PauseCloudRecording()

virtual SDKError IMeetingRecordingController::PauseCloudRecording ( )

pure virtual

Pause cloud recording.

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

◆ PauseRecording()

virtual SDKError IMeetingRecordingController::PauseRecording ( )

pure virtual

Pause recording.

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

◆ RequestLocalRecordingPrivilege()

virtual SDKError IMeetingRecordingController::RequestLocalRecordingPrivilege ( )

pure virtual

Sends a request to enable the SDK to start local recording.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS and the SDK will send the request. Otherwise it fails and the request will not be sent.

◆ RequestStartCloudRecording()

virtual SDKError IMeetingRecordingController::RequestStartCloudRecording ( )

pure virtual

Sends a request to ask the host to start cloud recording.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS and the SDK sends the request. Otherwise it fails and the request is not sent.

◆ ResumeCloudRecording()

virtual SDKError IMeetingRecordingController::ResumeCloudRecording ( )

pure virtual

Resume cloud recording.

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

◆ ResumeRecording()

virtual SDKError IMeetingRecordingController::ResumeRecording ( )

pure virtual

Resume recording.

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

◆ SetEvent()

virtual SDKError IMeetingRecordingController::SetEvent ( IMeetingRecordingCtrlEvent * pEvent )

pure virtual

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

◆ StartCloudRecording()

virtual SDKError IMeetingRecordingController::StartCloudRecording ( )

pure virtual

Starts cloud recording.

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

◆ StartRawRecording()

virtual SDKError IMeetingRecordingController::StartRawRecording ( )

pure virtual

Starts rawdata recording.

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

◆ StartRecording()

virtual SDKError IMeetingRecordingController::StartRecording ( time_t & startTimestamp )

pure virtual

Starts recording.

Parameters

[out] startTimestamp The timestamps when start recording.

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

◆ StopCloudRecording()

virtual SDKError IMeetingRecordingController::StopCloudRecording ( )

pure virtual

Stops cloud recording.

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

◆ StopRawRecording()

virtual SDKError IMeetingRecordingController::StopRawRecording ( )

pure virtual

Stops rawdata recording.

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

◆ StopRecording()

virtual SDKError IMeetingRecordingController::StopRecording ( time_t & stopTimestamp )

pure virtual

Stops recording.

Parameters

[out] stopTimestamp The timestamps when stop recording.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ AllowLocalRecording()

◆ CanAllowDisAllowLocalRecording()

◆ CanEnableSmartRecordingFeature()

◆ CanStartRawRecording()

◆ CanStartRecording()

◆ DisAllowLocalRecording()

◆ EnableSmartRecording()

◆ GetCloudRecordingStatus()

◆ IsSmartRecordingEnabled()

◆ IsSupportLocalRecording()

◆ IsSupportRequestLocalRecordingPrivilege()

◆ PauseCloudRecording()

◆ PauseRecording()

◆ RequestLocalRecordingPrivilege()

◆ RequestStartCloudRecording()

◆ ResumeCloudRecording()

◆ ResumeRecording()

◆ SetEvent()

◆ StartCloudRecording()

◆ StartRawRecording()

◆ StartRecording()

◆ StopCloudRecording()

◆ StopRawRecording()

◆ StopRecording()