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.

Description	Get recording bitrate in Mbps.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/bitrate`
Response	The recording bitrate.
Response Type	Number
Response Example	CODE `25`

Description	Set recording bitrate in Mbps.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/bitrate/1 - 100`
Parameter(s):	֍ Bitrate: Values between 1 - 100
Response	None

Description	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": "25", "Resolution": "HD", "VideoCodec": "H264" }`

Description	Update the recording settings.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/recording/configs/update`
Body	CODE `{ "VideoCodec":"H265", "Framerate":"30", "Bitrate":"100", "Resolution":"1920x1080" }`
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.

Description	Gets the directory name.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/directorytemplate`
Response	Directory template.
Response Type	Text
Response Example	CODE `Recording_SYNC_{yyyy}-{MM}-{dd}`

Description	Set the recording directory template (Tags example: {yyyy}{MM}{dd}).
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/directorytemplate/${yyyy}${MM}${dd}`
Parameter(s):	֍ Template: The template.
Response	None

Description	Gets the current recording duration in hh:mm:ss format
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/duration`
Response	Recording timer.
Response Type	TimeSpan
Response Example	CODE `00:10:30`

Description	Get recording encoder.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/encoder`
Response	The recording encoder.
Response Type	Text
Response Example	CODE `H264`

Description	Set recording encoder.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/encoder/h264`
Parameter(s):	֍ Encoder: Values between h264 or h265
Response	None

Description	Gets the filename template.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/filenametemplate`
Response	Filename template.
Response Type	Text
Response Example	CODE `{HH}{mm}{ss}.{fff}`

Description	Set the recording filename template (Tags example: ${HH}${mm}${ss}).
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/filenametemplate/${HH}${mm}${ss}`
Parameter(s):	֍ Template: Values between ${yyyy} or ${MM} or ${dd} or ${HH} or ${mm} or ${ss} or ${ms} or ${fff}
Response	None

Description	Get recording framerate.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/framerate`
Response	The recording framerate.
Response Type	Number
Response Example	CODE `30`

Description	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`

Description	Gets the path template set for recording.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/pathtemplate`
Response	path in string.
Response Type	Text
Response Example	CODE `Recording_SYNC_{yyyy}-{MM}-{dd}/{HH}{mm}{ss}.{fff}`

Description	Sets the path template for saving Videos.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/recording/pathtemplate`
Body	CODE `{ "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}" }`
Response	None
Response Type	None
Response Example	Payload: CODE `{ "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}" }` Command: CODE `curl -X POST http://<ip>:<port>/api/recording/pathtemplate -H 'Content-Type: application/json' -d '{ "PathTemplate":"Videos/{HH}{mm}{ss}.{fff}" }'`
Explanation	Sets the path template location for saving videos.

Description	Set recording preset.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/preset/hd`
Parameter(s):	֍ Preset: Values between hd or fhd30 or uhd30 or 4k
Response	None

Description	Get recording resolution.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/resolution`
Response	The recording resolution.
Response Type	Text
Response Example	CODE `HD`

Description	Start recording.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/start`
Response	None

Description	Start recording. (returns if the storage is full or not).
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/startwithfeedback`
Response	A representing the asynchronous operation.
Response Type	Text
Response Example	Recording started successfully or Storage is full. Cannot record any more videos

Description	Stop recording.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/recording/stop`
Response	None