Video Recorder

API reference for the "/video/recording" endpoint and "/recordings" endpoint.

For all headers refer to Overview --> Headers

Config Request

The purpose of this request is to setup the video recorder.

Endpoint

PUT http://{axibo-ip}:2200/v1/video/recording/config

Body Properties

Property	Type	Required	Description
frameRate	int	Yes	Sets the frame rate of the video recording.
codec	string	Yes	Sets the codec of the video recording.
format	string	Yes	Sets the output format of the video recording.

Example (PUT)

{
    "frameRate": 30,
    "codec":"avc1",
    "format":".mp4"
}

Start/Stop Requests

The purpose of this request is to set the name and start the recording.

Endpoint

PUT http://{axibo-ip}:2200/v1/video/recording

Body Properties

Property	Type	Required	Description
setName	string	Yes
startRecording	boolean	Yes
maxTime	int	Yes

Example (PUT)

{
    "setName": "Example",
    "startRecording": true,
    "maxTime": 30
}

List Recordings Request

Get Video Request

Delete Video Request

This requests will delete all videos that are currently saved.

Endpoint

DELETE http://{axibo-ip}:2200/v1/video/recording/all

Example (DELETE)

Check Status Request

The purpose of this request is to check whether the recording is in progress.

Endpoint

GET http://{axibo-ip}:2200/v1/video/recording/status

Example (GET)