Skip to content

Latest commit

 

History

History
286 lines (217 loc) · 6.5 KB

timelapse.rst

File metadata and controls

286 lines (217 loc) · 6.5 KB
Raw

Timelapse

Retrieve a list of timelapses and the current config

Delete a timelapse

Issue a command for an unrendered timelapse

Delete an unrendered timelapse

Change current timelapse config

Data model

Timelapse list

Name Multiplicity Type Description
config 1 Timelapse config <sec-api-timelapse-datamodel-config> Current timelapse configuration
files 0..* List of rendered timelapses <sec-api-timelapse-datamodel-rendered> List of rendered timelapse entries
unrendered 0..* List of unrendered timelapses <sec-api-timelapse-datamodel-unrendered> List of unrendered timelapse entries, only present if requested

Rendered timelapse

Name Multiplicity Type Description
name 1 string Name of the timelapse file
size 1 string Formatted size of the timelapse file
bytes 1 int Size of the timelapse file in bytes
date 1 string Formatted timestamp of the timelapse creation date
url 1 string URL for downloading the timelapse
thumbnail 1 string URL for downloading a thumbnail of the timelapse (optional)

Unrendered timelapse

Name Multiplicity Type Description
name 1 string Name of the unrendered timelapse job
size 1 string Formatted size of all files in the unrendered timelapse job
bytes 1 int Size of all files in the unrendered timelapse job in bytes
date 1 string Formatted timestamp of the timelapse job creation date
recording 1 bool Whether the timelapse is still being recorded (true) or not (false)
rendering 1 bool Whether the timelapse is still being rendered (true) or not (false)
processing 1 bool Whether the timelapse is either still being recorded or rendered (true) or not (false)

Timelapse configuration

Name Multiplicity Type Description
type 1 string Type of the timelapse, either off, zchange or timed.
save 1 bool Optional flag to be included when when saving a configuration to make the configuration persist across restarts

Further fields are timelapse type specific, see below for details.

Z-change-triggered timelapse

For timelapse type zchange.

Name Multiplicity Type Description
postRoll 1 int Configured post roll in seconds
fps 1 int Frames per second to use for rendered video
retractionZHop 1 float Size of retraction Z hop to detect and ignore for z-based snapshots
minDelay 1 int Snapshots will be rate limited against this interval, to prevent performance issues with vase mode/continuous z prints

Time triggered timelapse

For timelapse type timed.

Name Multiplicity Type Description
postRoll 1 int Configured post roll in seconds
fps 1 int Frames per second to use for rendered video
interval 1 int Seconds between individual shots