StillController

Last updated: 2025/3/7 11:58:11
Path To	Name	Description/Function
/api/still	/imageformat	Get the image format.
/api/still	/jpegquality	Get the JPEG quality.
/api/still	/pathtemplate	Get the path template.
/api/still	/rdi/actualrate	Gets the Actual RDI rate in seconds per still.
/api/still	/rdi/rate	Gets the RDI rate in seconds per still.
/api/still	/hascapturefailed	Gets a value indicating whether the still capture has failed.
/api/still	/ismonoenabled	Gets whether monochrome is enabled.
/api/still	/ismonoenabled/{ismonoenabled}	Enable/disable monochrome.
/api/still	/rdi/isrdiing	IsRDIing.
/api/still	/isstillrequestpending	Gets a value indicating whether a still request is pending.
/api/still	/reset	Reset the image reader in the event of a failure.
/api/still	/directorytemplate	Gets the directory name.
/api/still	/directorytemplate/{template}	Set the still directory template (Tags example: {yyyy}{MM}{dd}).
/api/still	/filenametemplate	Gets the file name.
/api/still	/filenametemplate/{template}	Set the still filename template (Tags example: {hh}{mm}{ss}).
/api/still	/imageformat/{value}	Set the image format used for saving stills.
/api/still	/jpegquality/{value}	Set the JPEG quality.
/api/still	/pathtemplate	Set the path template.
/api/still	/rdi/rate/{rate}	Set RDI rate.
/api/still	/rdi/start	Start RDI.
/api/still	/rdi/startwithfeedback	Start RDI.
/api/still	/rdi/stop	RDI service.
/api/still	/take	Take a still with the camera.
/api/still	/takeanddispose	Take a still with the camera.
/api/still	/takeandftp	Take a still with the camera and upload it to ftp.
/api/still	/takeandget	Take a still with the camera.
/api/still	/takeandsavewithfeedback	Take a still with the camera with the current path template. (returns if the storage is full or not).
/api/still	/takeandsave	Take a still with the camera with the current path template.
/api/still	/takeandsave/{filename}	Take a still with the camera with the supplied filename.
/api/still	/takeandsave	Take a still with the camera with the supplied path template.

/imageformat

Function	Get the image format.
Method	Get
Response	The image format used for saving stills.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/imageformat`

/jpegquality

Function	Get the JPEG quality.
Method	Get
Response	The quality of the JPEG.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/jpegquality`

/pathtemplate

Function	Get the path template.
Method	Get
Response	The template of the still path.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/pathtemplate`

/rdi/actualrate

Function	Gets the Actual RDI rate in seconds per still.
Method	Get
Response	Actual RDI rate.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/rdi/actualrate`

/rdi/rate

Function	Gets the RDI rate in seconds per still.
Method	Get
Response	RDI rate.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/rdi/rate`

/hascapturefailed

Function	Gets a value indicating whether the still capture has failed.
Method	Get
Response	True if the previous still still capture has failed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/hascapturefailed`

/ismonoenabled

Function	Gets whether monochrome is enabled.
Method	Get
Response	If mono is enabled or not.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/ismonoenabled`

/ismonoenabled/{ismonoenabled}

Function	Enable/disable monochrome.
Method	Get
Response	true or false.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/ismonoenabled/{ismonoenabled}`

/rdi/isrdiing

Function	IsRDIing.
Method	Get
Response	Isrdiing.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/rdi/isrdiing`

/isstillrequestpending

Function	Gets a value indicating whether a still request is pending.
Method	Get
Response	True if a still request is still pending.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/isstillrequestpending`

/reset

Function	Reset the image reader in the event of a failure.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/reset`

/directorytemplate

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

/directorytemplate/{template}

Function	Set the still directory template (Tags example: {yyyy}{MM}{dd}).
Method	Get
Response	The template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/directorytemplate/{template}`

/filenametemplate

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

/filenametemplate/{template}

Function	Set the still filename template (Tags example: {hh}{mm}{ss}).
Method	Get
Response	The template.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/filenametemplate/{template}`

/imageformat/{value}

Function	Set the image format used for saving stills.
Method	Get
Response	The image format to set.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/imageformat/{value}`

/jpegquality/{value}

Function	Set the JPEG quality.
Method	Get
Response	Value of the quality to set.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/jpegquality/{value}`

/pathtemplate

Function	Set the path template.
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"`

/rdi/rate/{rate}

Function	Set RDI rate.
Method	Get
Response	RDI rate.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/rdi/rate/{rate}`

/rdi/start

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

/rdi/startwithfeedback

Function	Start RDI.
Method	Get
Response	A representing the asynchronous operation.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/rdi/startwithfeedback`

/rdi/stop

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

/take

Function	Take a still with the camera.
Method	Get
Response	The byte array of the still.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/take`

/takeanddispose

Function	Take a still with the camera.
Method	Get
Response	Status code 200, for an completed operation being preformed.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeanddispose`

/takeandftp

Function	Take a still with the camera and upload it to ftp.
Method	Post
Body	CODE `{ "URL":"ftp://192.168.2.1", "Username":"user", "Password":"pass" }`
Response	The byte array of the still.
Explanation	Instructs the camera to take a still and upload it to the ftp server described in the post body.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandftp`

/takeandget

Function	Take a still with the camera.
Method	Get
Response	The byte array of the still.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandget`

/takeandsavewithfeedback

Function	Take a still with the camera with the current path template. (returns if the storage is full or not).
Method	Get
Response	Path of the still taken.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandsavewithfeedback`

/takeandsave

Function	Take a still with the camera with the current path template.
Method	Get
Response	Path of the still taken.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandsave`

/takeandsave/{filename}

Function	Take a still with the camera with the supplied filename.
Method	Get
Response	Path of the still taken.
Example	CODE `$ curl http://IP_ADDRESS:8080>/api/still/takeandsave/{filename}`

/takeandsave

Function	Take a still with the camera with the supplied path template.
Method	Post
Body	{ "Template": "{string}" }
Response	Path of the still taken.
Explanation	Using the command: CODE `http://<ip>:8080/api/still/takeandsave` With the template provided above, will give the result provided below.
Example	Example 1 CODE `{ "Template": "ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }` CODE `$ curl -X POST http://<ip>:8080/api/still/takeandsave -H 'Content-Type: application/json' -d '{ "Template": "ProjectName-Still/{yyyy}{MM}{dd}-{HH}{mm}{ss}" }'` Results CODE `"/mnt/expand/64180671-0e95-4e34-9381-0780ce582c9c/DCIM/ProjectName-Still/20230803-093136.jpg"`