Recording Commands
Last updated: 2026/1/7 17:29:57 | ||
Path To | Name | Description/Function |
/api/recording | /bitrate | Get recording bitrate in bps. |
/api/recording | /bitrate/{bitrate} | Set recording bitrate. |
/api/recording | /configs/get | Get recording configs/settings. |
/api/recording | /configs/update | Update the recording settings. |
/api/recording | /directorytemplate | Gets the directory name. |
/api/recording | /directorytemplate/{template} | Set the recording directory template (Tags example: {yyyy}{MM}{dd}). |
/api/recording | /duration | Gets the curernt recording duration. |
/api/recording | /encoder | Get recording encoder. |
/api/recording | /encoder/{encoder} | Set recording encoder. |
/api/recording | /filenametemplate | Gets the filename template. |
/api/recording | /filenametemplate/{template} | Set the recording filename template (Tags example: ${HH}${mm}${ss}). |
/api/recording | /framerate | Get recording framerate. |
/api/recording | /isrecording | Gets if recording is in progress. |
/api/recording | /pathtemplate | Gets the path template set for recording. |
/api/recording | /pathtemplate | Sets the path template for saving Videos. |
/api/recording | /preset/{preset} | Set recording preset. |
/api/recording | /resolution | Get recording resolution. |
/api/recording | /start | Start recording. |
/api/recording | /startwithfeedback | Start recording. (returns if the storage is full or not). |
/api/recording | /stop | Stop recording. |
/bitrate
Description | Get recording bitrate in Mbps. |
Method | Get |
Example |
CODE
|
Response | The recording bitrate. |
Response Type | Number |
Response Example |
CODE
|
/bitrate/{bitrate}
Description | Set recording bitrate in Mbps. |
Method | Get |
Example |
CODE
|
Parameter(s): | ֍ Bitrate: Values between 1 - 100 |
Response | None |
/configs/get
Description | Get recording configs/settings. |
Method | Get |
Example |
CODE
|
Response | Dictionary of recording configs and their values. |
Response Type | JSON object |
Response Example |
CODE
|
/configs/update
Description | Update the recording settings. |
Method | Post |
Example |
CODE
|
Body |
CODE
|
Response | None |
Response Type | None |
Response Example | 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. |
/directorytemplate
Description | Gets the directory name. |
Method | Get |
Example |
CODE
|
Response | Directory template. |
Response Type | Text |
Response Example |
CODE
|
/directorytemplate/{template}
Description | Set the recording directory template (Tags example: {yyyy}{MM}{dd}). |
Method | Get |
Example |
CODE
|
Parameter(s): | ֍ Template: The template. |
Response | None |
/duration
Description | Gets the current recording duration in hh:mm:ss format |
Method | Get |
Example |
CODE
|
Response | Recording timer. |
Response Type | TimeSpan |
Response Example |
CODE
|
/encoder
Description | Get recording encoder. |
Method | Get |
Example |
CODE
|
Response | The recording encoder. |
Response Type | Text |
Response Example |
CODE
|
/encoder/{encoder}
Description | Set recording encoder. |
Method | Get |
Example |
CODE
|
Parameter(s): | ֍ Encoder: Values between h264 or h265 |
Response | None |
/filenametemplate
Description | Gets the filename template. |
Method | Get |
Example |
CODE
|
Response | Filename template. |
Response Type | Text |
Response Example |
CODE
|
/filenametemplate/{template}
Description | Set the recording filename template (Tags example: ${HH}${mm}${ss}). |
Method | Get |
Example |
CODE
|
Parameter(s): | ֍ Template: Values between ${yyyy} or ${MM} or ${dd} or ${HH} or ${mm} or ${ss} or ${ms} or ${fff} |
Response | None |
/framerate
Description | Get recording framerate. |
Method | Get |
Example |
CODE
|
Response | The recording framerate. |
Response Type | Number |
Response Example |
CODE
|
/isrecording
Description | Gets if recording is in progress. |
Method | Get |
Example |
CODE
|
Response | true or false. |
Response Type | Boolean |
Response Example |
CODE
|
/pathtemplate
Description | Gets the path template set for recording. |
Method | Get |
Example |
CODE
|
Response | path in string. |
Response Type | Text |
Response Example |
CODE
|
/pathtemplate
Description | Sets the path template for saving Videos. |
Method | Post |
Example |
CODE
|
Body |
CODE
|
Response | None |
Response Type | None |
Response Example | Payload:
CODE
Command:
CODE
|
Explanation | Sets the path template location for saving videos. |
/preset/{preset}
Description | Set recording preset. |
Method | Get |
Example |
CODE
|
Parameter(s): | ֍ Preset: Values between hd or fhd30 or uhd30 or 4k |
Response | None |
/resolution
Description | Get recording resolution. |
Method | Get |
Example |
CODE
|
Response | The recording resolution. |
Response Type | Text |
Response Example |
CODE
|
/start
Description | Start recording. |
Method | Get |
Example |
CODE
|
Response | None |
/startwithfeedback
Description | Start recording. (returns if the storage is full or not). |
Method | Get |
Example |
CODE
|
Response | A representing the asynchronous operation. |
Response Type | Text |
Response Example | Recording started successfully or Storage is full. Cannot record any more videos |
/stop
Description | Stop recording. |
Method | Get |
Example |
CODE
|
Response | None |