RecordingController

Last updated: 2025/3/7 11:9:0
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}	Get the path template.
/api/recording	/encoder/{encoder}	Set recording encoder (for parity with v3).
/api/recording	/filenametemplate	Gets the file name.
/api/recording	/filenametemplate/{template}	Get the path template.
/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.

Function	Gets the curernt recording duration.
Method	Get
Response	Recording timer.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/duration`

Function	Get recording bitrate (for parity with v3).
Method	Get
Response	The recording bitrate.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/bitrate`

Function	Get recording configs/settings.
Method	Get
Response	Dict of recording configs and their values.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/configs/get`

Function	Get recording encoder (for parity with v3).
Method	Get
Response	The recording encoder.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/encoder`

Function	Get recording framerate (for parity with v3).
Method	Get
Response	The recording framerate.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/framerate`

Function	Gets if recording is in progress.
Method	Get
Response	true or false.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/isrecording`

Function	Gets the path template set for recording.
Method	Get
Response	path in string.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/pathtemplate`

Function	Get recording resolution (for parity with v3).
Method	Get
Response	The recording resolution.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/resolution`

Function	Set recording bitrate (for parity with v3).
Method	Get
Response	Either UHD30 or FHD30.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/bitrate/{bitrate}`

Function	Gets the directory name.
Method	Get
Response	Directory template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/directorytemplate`

Function	Get the path template.
Method	Get
Response	The template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/directorytemplate/{template}`

Function	Set recording encoder (for parity with v3).
Method	Get
Response	Either UHD30 or FHD30.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/encoder/{encoder}`

Function	Gets the file name.
Method	Get
Response	Filename template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/filenametemplate`

Function	Get the path template.
Method	Get
Response	The template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/filenametemplate/{template}`

Function	Sets the path template for saaving Videos.
Method	Post
Body	CODE `{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }`
Response	A representing the asynchronous operation.
Explanation	The filename formatting, see the available formats below: yyyy = Four(4) digit current year. MM = Two(2) digit month. dd = Two(2) digit day. HH = Two(2) digit 24-hour clock. hh = Two(2) digit 12-hour clock. Will include “AM” and “PM” in the results. mm = Minutes with a leading zero. ss = Seconds with leading zero. fff = Represents the three most significant digits of the seconds' fraction; that is, it represents the milliseconds in a date and time value.
Example	Example 1 CODE `{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }` Output CODE `$ curl -X POST http://<ip>:<port>/api/still/pathtemplate/get -H 'Content-Type: application/json' -d '{ "PathTemplate":"ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }' $ "ProjectName-Still/2023-05-17-160223"`

Function	Set recording preset (for parity with v3).
Method	Get
Response	Either UHD30 or FHD30.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/preset/{preset}`

Function	Start recording. (returns if the storage is full or not).
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/startwithfeedback`

Function	Start recording.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/start`

Function	Stop recording.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/recording/stop`

Function	Update the recording settings.
Method	Post
Body	CODE `{ "VideoCodec":"H265", "Framerate":"30", "Bitrate":"100", "Resolution":"1920x1080" }`
Response	A representing the asynchronous operation.
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 `$ curl http://IP_ADDRESS:8080>/api/recording/configs/update`