Skip to main content
Skip table of contents

Recording Commands

Last updated: 2025/5/26 10:52:3

Path To

Name

Description/Function

/api/recording

/duration

Gets the curernt recording duration.

/api/recording

/bitrate

Get recording bitrate (for parity with v3).

/api/recording

/configs/get

Get recording configs/settings.

/api/recording

/encoder

Get recording encoder (for parity with v3).

/api/recording

/framerate

Get recording framerate (for parity with v3).

/api/recording

/isrecording

Gets if recording is in progress.

/api/recording

/pathtemplate

Gets the path template set for recording.

/api/recording

/resolution

Get recording resolution (for parity with v3).

/api/recording

/bitrate/{bitrate}

Set recording bitrate (for parity with v3).

/api/recording

/directorytemplate

Gets the directory name.

/api/recording

/directorytemplate/{template}

Set the recording directory template (Tags example: {yyyy}{MM}{dd}).

/api/recording

/encoder/{encoder}

Set recording encoder (for parity with v3).

/api/recording

/filenametemplate

Gets the file name.

/api/recording

/filenametemplate/{template}

Set the recording filename template (Tags example: {hh}{mm}{ss}).

/api/recording

/pathtemplate

Sets the path template for saaving Videos.

/api/recording

/preset/{preset}

Set recording preset (for parity with v3).

/api/recording

/startwithfeedback

Start recording. (returns if the storage is full or not).

/api/recording

/start

Start recording.

/api/recording

/stop

Stop recording.

/api/recording

/configs/update

Update the recording settings.

/duration

Function

Gets the curernt recording duration.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/duration

Response

Recording timer.

Response Type

TimeSpan

Response Example

CODE
00:12:34

/bitrate

Function

Get recording bitrate.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/bitrate

Response

The recording bitrate.

Response Type

number

Response Example

CODE
100000

/configs/get

Function

Get recording configs/settings.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/configs/get

Response

Dictionary of recording configs and their values.

Response Type

JSON object

Response Example

CODE
{
  "Framerate": "30",
  "Bitrate": "100",
  "Resolution": "HD",
  "VideoCodec": "H264"
}

/encoder

Function

Get recording encoder (for parity with v3).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/encoder

Response

The recording encoder.

Response Type

string

Response Example

CODE
H264

/framerate

Function

Get recording framerate (for parity with v3).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/framerate

Response

The recording framerate.

Response Type

number

Response Example

CODE
30

/isrecording

Function

Gets if recording is in progress.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/isrecording

Response

true or false.

Response Type

boolean

Response Example

CODE
false

/pathtemplate

Function

Gets the path template set for recording.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/pathtemplate

Response

path in string.

Response Type

string

Response Example

CODE
Videos/{HH}{mm}{ss}.{fff}

/resolution

Function

Get recording resolution (for parity with v3).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/resolution

Response

The recording resolution.

Response Type

string

Response Example

CODE
HD

/bitrate/{bitrate}

Function

Set recording bitrate in bps.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/bitrate/{bitrate}

Response

None

Response Type

Not Available

Response Example

CODE
Not Available

/directorytemplate

Function

Gets the directory name.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/directorytemplate

Response

Directory template.

Response Type

string

Response Example

CODE
Recording_SYNC_{yyyy}-{MM}-{dd}

/directorytemplate/{template}

Function

Set the recording directory template (Tags example: {yyyy}{MM}{dd}).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/directorytemplate/{template}

Response

None

Response Type

Not Available

Response Example

CODE
Not Available

/encoder/{encoder}

Function

Set recording encoder to either H264 or H265.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/encoder/{encoder}

Response

None

Response Type

Not Available

Response Example

CODE
Not Available

/filenametemplate

Function

Gets the file name.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/filenametemplate

Response

Filename template.

Response Type

string

Response Example

CODE
{HH}{mm}{ss}.{fff}

/filenametemplate/{template}

Function

Set the recording filename template (Tags example: {hh}{mm}{ss}).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/filenametemplate/{template}

Response

None

Response Type

Not Available

Response Example

CODE
Not Available

/pathtemplate

Function

Sets the path template for saving Videos.

Method

Post

Body

CODE
{
  "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}"
}

Response

None

Explanation

Sets the path template location for saving videos.

Example

Example 1

CODE
{
  "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}"
}

Output

CODE
curl -X POST http://<ip>:<port>/api/recording/pathtemplate
   -H 'Content-Type: application/json'
   -d '{ "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}" }'

Response Type

None

Response Example

N/A

/preset/{preset}

Function

Set recording preset to either UHD30 or FHD30..

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/preset/{preset}

Response

None

Response Type

Not Available

Response Example

CODE
Not Available

/startwithfeedback

Function

Start recording. (returns if the storage is full or not).

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/startwithfeedback

Response

A message indicating what happened

Response Type

string

Response Example

CODE
Recording started successfully

/start

Function

Start recording.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/start

Response

None

Response Type

none

Response Example

CODE
Response OK(200)

/stop

Function

Stop recording.

Method

Get

Example

CODE
http://IP_ADDRESS:8080/api/recording/stop

Response

Status code 200, for completed operation being preformed.

Response Type

none

Response Example

CODE
Response OK(200)

/configs/update

Function

Update the recording settings.

Method

Post

Body

CODE
{
  "VideoCodec":"H265",
  "Framerate":"30",
  "Bitrate":"100",
  "Resolution":"1920x1080"
}

Response

None

Explanation

Sets any of the above properties for recording. VideoCodec can be either H264 or H265, Framerate can be between 1 and 60, Bitrate can be between 1 and 100, Resolution must be a standard resolution between SD and 4K.

Example

CODE
http://IP_ADDRESS:8080/api/recording/configs/update

Response Type

None

Response Example

N/A

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.