Haivision Media Platform
Haivision Media Platform
Breadcrumbs

Get Recording Status

This command gets the status of the specified active recording.

Authorizations: All

Request

getRecordingStatus recordingId

Parameters

Name

Description

recordingId

The ID of a HMP recording.

Result

Success

state

where state could be one of the following:

  • RECORDING: It is currently being recorded (active recording).

  • PAUSED: Recording has already started but is currently paused.

  • FINISHED: Recording has finished recording.

  • ERROR: Any other error on the recording will be set to this state.

Error

Error

Description

ERROR|010003|Expected 1 parameter(s).
Got Y parameter(s)

Calling getRecordingStatus requires 1 parameter.

ERROR|010001|'Y' is not a UUID

The recordingId provided must be a UUID.

ERROR|040001|Active recording not found

The recording with UUID 'recordingId' was not found.

ERROR|070003|Recording not found

A recording with UUID 'recordingId' was not found.

Example

getRecordingStatus f678f415-0665-48cd-b141-1e95283469f1

OK|PAUSED