Meeting Recording helper interface. More...

#include <IRecordingHelper.h>

Public Member Functions
virtual	~IRecordingHelper ()

virtual ZRCSDKError	RegisterSink (IRecordingHelperSink *pSink)=0
	Register meeting recording helper callback sink.

virtual ZRCSDKError	DeregisterSink (IRecordingHelperSink *pSink)=0
	Deregister meeting recording helper callback sink.

virtual ZRCSDKError	ConfirmRecordingError ()=0
	Confirm recording error, after this API called, Zoom Room will notify all ZRCs to close the error dialog.

virtual ZRCSDKError	IsNeedPromptStartRecordingDisclaimer (bool &need)=0
	Need prompt start recording disclaimer.

virtual ZRCSDKError	PromptStartRecordingDisclaimer ()=0
	Prompt start recording disclaimer on Zoom Room.

virtual ZRCSDKError	IsMeetingCMRNoStorage (bool &full)=0
	Meeting CMR storage status, initialized when meeting begins.

virtual ZRCSDKError	QueryMeetingRecordingStorage ()=0
	Query meeting recording storage.

virtual ZRCSDKError	SetMeetingRecordingNotificationEmail (const std::string &email)=0
	Set the recording notification email, meeting recording will be sent to the email.

virtual ZRCSDKError	StartMeetingCloudRecording ()=0
	Start meeting cloud recording.

virtual ZRCSDKError	StopMeetingCloudRecording ()=0
	Stop meeting cloud recording.

virtual ZRCSDKError	PauseMeetingCloudRecording ()=0
	Pause meeting cloud recording.

virtual ZRCSDKError	ResumeMeetingCloudRecording ()=0
	Resume meeting cloud recording.

virtual ZRCSDKError	AllowUserRecording (int32_t userID, bool allow)=0
	Allow user recording.

virtual ZRCSDKError	ResponseToRecordingRequest (bool agree, bool isPersist)=0
	Response to the latest meeting recording request.

virtual ZRCSDKError	ChangeRecordingPermission (RecordingPermissionType type, bool enable)=0
	Change the permission of recording in this meeting.

virtual ZRCSDKError	GetRecoringPemissionInfo (std::vector< RecordPermissionInfo > &permissionInfo)=0
	Get the permission of recording in this meeting.

Detailed Description

Meeting Recording helper interface.

Definition at line 212 of file IRecordingHelper.h.

Constructor & Destructor Documentation

◆ ~IRecordingHelper()

virtual IRecordingHelper::~IRecordingHelper ( )

inlinevirtual

Definition at line 215 of file IRecordingHelper.h.

215{}

Member Function Documentation

◆ AllowUserRecording()

virtual ZRCSDKError IRecordingHelper::AllowUserRecording	(	int32_t	userID,
		bool	allow
	)

pure virtual

Allow user recording.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to allow recording.
allow	TRUE indicates allow the user to record. Otherwise not.

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

◆ ChangeRecordingPermission()

virtual ZRCSDKError IRecordingHelper::ChangeRecordingPermission	(	RecordingPermissionType	type,
		bool	enable
	)

pure virtual

Change the permission of recording in this meeting.

Since: 6.3.5

Zoom Rooms minimum version: 6.3.0

Parameters

type	Specify the permission which will be changed.
enable	TRUE indicates enable. Otherwise not.

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

◆ ConfirmRecordingError()

virtual ZRCSDKError IRecordingHelper::ConfirmRecordingError ( )

pure virtual

Confirm recording error, after this API called, Zoom Room will notify all ZRCs to close the error dialog.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ DeregisterSink()

virtual ZRCSDKError IRecordingHelper::DeregisterSink ( IRecordingHelperSink * pSink )

pure virtual

Deregister meeting recording helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IRecordingHelperSink that receives the meeting recording helper callback.

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

◆ GetRecoringPemissionInfo()

virtual ZRCSDKError IRecordingHelper::GetRecoringPemissionInfo ( std::vector< RecordPermissionInfo > & permissionInfo )

pure virtual

Get the permission of recording in this meeting.

Since: 6.3.5

Zoom Rooms minimum version: 6.3.0

Parameters

permissionInfo The permission of recording in this meeting.

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

◆ IsMeetingCMRNoStorage()

virtual ZRCSDKError IRecordingHelper::IsMeetingCMRNoStorage ( bool & full )

pure virtual

Meeting CMR storage status, initialized when meeting begins.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] full TRUE indicates meeting CMR storage is full, before you starting cloud recording, you should QueryMeetingRecordingStorage first to check the latest status.

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

◆ IsNeedPromptStartRecordingDisclaimer()

virtual ZRCSDKError IRecordingHelper::IsNeedPromptStartRecordingDisclaimer ( bool & need )

pure virtual

Need prompt start recording disclaimer.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] need TRUE indicates you need to prompt a start recording disclaimer before starting the recording.

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

◆ PauseMeetingCloudRecording()

virtual ZRCSDKError IRecordingHelper::PauseMeetingCloudRecording ( )

pure virtual

Pause meeting cloud recording.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ PromptStartRecordingDisclaimer()

virtual ZRCSDKError IRecordingHelper::PromptStartRecordingDisclaimer ( )

pure virtual

Prompt start recording disclaimer on Zoom Room.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

You will get a OnMeetingReminderNotification of type REMINDER_TYPE_RECORDING_DISCLAIMER after calling this function.

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

◆ QueryMeetingRecordingStorage()

virtual ZRCSDKError IRecordingHelper::QueryMeetingRecordingStorage ( )

pure virtual

Query meeting recording storage.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ RegisterSink()

virtual ZRCSDKError IRecordingHelper::RegisterSink ( IRecordingHelperSink * pSink )

pure virtual

Register meeting recording helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IRecordingHelperSink that receives the meeting recording helper callback.

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

◆ ResponseToRecordingRequest()

virtual ZRCSDKError IRecordingHelper::ResponseToRecordingRequest	(	bool	agree,
		bool	isPersist
	)

pure virtual

Response to the latest meeting recording request.

Since: 6.3.5

Zoom Rooms minimum version: 6.3.0

Parameters

agree	TRUE indicates allow cloud recording or allow the user to record. Otherwise not.
isPersist	TRUE indicates apply the option of agree to all request automatically (local recording only) in this meeting. Otherwise not.

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

◆ ResumeMeetingCloudRecording()

virtual ZRCSDKError IRecordingHelper::ResumeMeetingCloudRecording ( )

pure virtual

Resume meeting cloud recording.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ SetMeetingRecordingNotificationEmail()

virtual ZRCSDKError IRecordingHelper::SetMeetingRecordingNotificationEmail ( const std::string & email )

pure virtual

Set the recording notification email, meeting recording will be sent to the email.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

email A pointer to the IThirdPartyMeetingHelperSink that receives the third party meeting helper callback.

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

◆ StartMeetingCloudRecording()

virtual ZRCSDKError IRecordingHelper::StartMeetingCloudRecording ( )

pure virtual

Start meeting cloud recording.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Before you start recording: 1.Check if needed show start recording disclaimer. 2.Check if CMR storage is full 3.Check if recording notification email is set.

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

Changelog

6.3.5: Supported ask host to satrt cloud recording since zr 6.3.0

◆ StopMeetingCloudRecording()

virtual ZRCSDKError IRecordingHelper::StopMeetingCloudRecording ( )

pure virtual

Stop meeting cloud recording.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IRecordingHelper()

Member Function Documentation

◆ AllowUserRecording()

◆ ChangeRecordingPermission()

◆ ConfirmRecordingError()

◆ DeregisterSink()

◆ GetRecoringPemissionInfo()

◆ IsMeetingCMRNoStorage()

◆ IsNeedPromptStartRecordingDisclaimer()

◆ PauseMeetingCloudRecording()

◆ PromptStartRecordingDisclaimer()

◆ QueryMeetingRecordingStorage()

◆ RegisterSink()

◆ ResponseToRecordingRequest()

◆ ResumeMeetingCloudRecording()

◆ SetMeetingRecordingNotificationEmail()

◆ StartMeetingCloudRecording()

◆ StopMeetingCloudRecording()