Still Commands

Last updated: 2026/1/7 17:42:17
Path To	Name	Description/Function
/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	/hascapturefailed	Gets a value indicating whether the still capture has failed.
/api/still	/imageformat	Get the image format.
/api/still	/imageformat/{value}	Set the image format used for saving stills.
/api/still	/ismonoenabled	Gets whether monochrome is enabled.
/api/still	/ismonoenabled/{ismonoenabled}	Enable/disable monochrome.
/api/still	/isstillrequestpending	Gets a value indicating whether a still request is pending.
/api/still	/jpegquality	Get the JPEG quality.
/api/still	/jpegquality/{value}	Set the JPEG quality.
/api/still	/pathtemplate	Get the path template.
/api/still	/pathtemplate	Set the path template.
/api/still	/rdi/actualrate	Gets the Actual RDI rate in seconds per still.
/api/still	/rdi/isrdiing	IsRDIing.
/api/still	/rdi/rate	Gets the RDI rate in seconds per still.
/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	/reset	Reset the image reader in the event of a failure.
/api/still	/take	Take a still with the camera.
/api/still	/takeanddispose	Take a still with the camera and discard it.
/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	/takeandget	Take a still with the camera.
/api/still	/takeandsave	Take a still with the camera with the current path template.
/api/still	/takeandsave	Take a still with the camera with the supplied path template.
/api/still	/takeandsave/{filename}	Take a still with the camera with the supplied filename.
/api/still	/takeandsavewithexif	Take a still with the camera with the current path template and supplied exif data. (returns if the storage is full or not).
/api/still	/takeandsavewithfeedback	Take a still with the camera with the current path template. (returns if the storage is full or not).

/directorytemplate

Description	Get the Stills directory template.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/directorytemplate`
Response	Directory template.
Response Type	Text
Response Example	CODE `Still_SYNC_{yyyy}-{MM}-{dd}`

/directorytemplate/{template}

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

/filenametemplate

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

/filenametemplate/{template}

Description	Set the Still filename template (Tags example: ${HH}${mm}${ss}).
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/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

/hascapturefailed

Description	Gets a value indicating whether the Still capture has failed.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/hascapturefailed`
Response	True if the previous still still capture has failed.
Response Type	Boolean
Response Example	CODE `false`

/imageformat

Description	Get the image format.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/imageformat`
Response	The image format used for saving stills.
Response Type	Text
Response Example	CODE `jpeg`

/imageformat/{value}

Description	Set the image format used for saving Stills.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/imageformat/jpg`
Parameter(s):	֍ Value: jpg or raw
Response	None

/ismonoenabled

Description	Gets whether monochrome is enabled.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/ismonoenabled`
Response	True if monochrome is enabled. False if monochrome is not enabled.
Response Type	Boolean
Response Example	CODE `false`

/ismonoenabled/{ismonoenabled}

Description	Enable/disable monochrome.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/ismonoenabled/true`
Parameter(s):	֍ Ismonoenabled: true or false
Response	None

/isstillrequestpending

Description	Gets a value indicating whether a still request is pending.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/isstillrequestpending`
Response	True if a still request is still pending.
Response Type	Boolean
Response Example	CODE `false`

/jpegquality

Description	Get the JPEG quality.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/jpegquality`
Response	The quality of the JPEG.
Response Type	Number
Response Example	CODE `75`

/jpegquality/{value}

Description	Set the JPEG quality.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/jpegquality/1 - 100`
Parameter(s):	֍ Value: Values between 1 - 100
Response	None

/pathtemplate

Description	Get the Stills path template.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/pathtemplate`
Response	The template of the still path.
Response Type	Text
Response Example	CODE `Still_SYNC_{yyyy}-{MM}-{dd}/{HH}{mm}{ss}.{fff}`

/pathtemplate

Description	Set the Stills path template.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/still/pathtemplate`
Body	CODE `{ "PathTemplate": "C:\\Images\\{YYYY}\\{MM}\\{DD}_{HHmmss}_image.jpg" }`
Response	None
Explanation	Task

/rdi/actualrate

Description	Gets the Actual RDI rate in seconds per Still.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/actualrate`
Response	Actual RDI rate. For JPEG -> 0.5 - 10 and for RAW -> 1.5 - 10.
Response Type	Decimal
Response Example	CODE `0.5`

/rdi/isrdiing

Description	IsRDIing.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/isrdiing`
Response	Isrdiing.
Response Type	Boolean
Response Example	CODE `false`

/rdi/rate

Description	Gets the RDI rate in seconds per Still.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/rate`
Response	RDI rate.
Response Type	Decimal
Response Example	CODE `0.5`

/rdi/rate/{rate}

Description	Set RDI rate.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/rate/0.5 - 10`
Parameter(s):	֍ Rate: Values between 0.5 - 10
Response	None

/rdi/start

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

/rdi/startwithfeedback

Description	Start RDI.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/startwithfeedback`
Response	A representing the asynchronous operation.
Response Type	Text
Response Example	CODE `Not Available`

/rdi/stop

Description	Stop RDI
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/rdi/stop`
Response	None

/reset

Description	Reset the image reader in the event of a failure.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/reset`
Response	None

/take

Description	Take a Still with the camera.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/take`
Response	The internal path to the still file.
Response Type	Text
Response Example	CODE `DCIM/Still_SYNC_2026-01-07/174105.702.dng`

/takeanddispose

Description	Take a still with the camera and discard it.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/takeanddispose`
Response	None

/takeandftp

Description	Take a still with the camera and upload it to ftp.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandftp`
Body	CODE `{ "Url": "ftp://ftp.example.com/stills/camera_shot_{Timestamp}.jpg", "Username": "cam_user", "Password": "strong_password123" }`
Response	None
Explanation	Task

/takeandget

Description	Take a still with the camera and return the image bytes.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandget`
Response	None

/takeandget

Description	Take a still with the camera and embed EXIF data in the image.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandget`
Body	CODE `{ "GPSLatitude" : "4810.62087035", "GPSLatitudeRef" : "N", "GPSLongitude" : "05357.8603", "GPSLongitudeRef" : "W", "GPSAltitude" : "230.05/1", "GPSAltitudeRef" : "1", "SubjectDistance" : "1.8", "DateTime" : "2025:11:18 13:34:06", "DateTimeDigitized" : "2025:11:18 13:34:06", "DateTimeOriginal" : "2025:11:18 13:34:06" }`
Response	None
Explanation	Task

/takeandsave

Description	Take a still with the camera and save with the current path template.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandsave`
Response	None

/takeandsave

Description	Take a still with the camera and save with the supplied path template.
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandsave`
Body	CODE `{ "Template": "/mnt/sdcard/stills/{Date:yyyyMMdd}/shot_{Time:HHmmss}.dng" }`
Response	Path of the still taken.
Response Type	Text
Explanation	Task

/takeandsave/{filename}

Description	Take a still with the camera with the supplied filename.
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandsave/sampleFilename`
Parameter(s):	֍ Filename: The filename to use.
Response	Path of the still taken.
Response Type	Text
Response Example	CODE `DCIM/Still_SYNC_2026-01-07/sampleFilename.jpg`

/takeandsavewithexif

Description	Take a still with the camera with the current path template and supplied exif data. (returns if the storage is full or not).
Method	Post
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandsavewithexif`
Body	CODE `{ "GPSLatitude" : "4810.62087035", "GPSLatitudeRef" : "N", "GPSLongitude" : "05357.8603", "GPSLongitudeRef" : "W", "GPSAltitude" : "230.05/1", "GPSAltitudeRef" : "1", "SubjectDistance" : "1.8", "DateTime" : "2025:11:18 13:34:06", "DateTimeDigitized" : "2025:11:18 13:34:06", "DateTimeOriginal" : "2025:11:18 13:34:06" }`
Response	Path of the still taken.
Response Type	Text
Explanation	Task

/takeandsavewithfeedback

Description	Take a still with the camera with the current path template. (returns if the storage is full or not).
Method	Get
Example	CODE `http://IP_ADDRESS:8080/api/still/takeandsavewithfeedback`
Response	Path of the still taken.
Response Type	Text
Response Example	CODE `DCIM/Still_SYNC_2026-01-07/sampleFilename_1.jpg`