Create Video

Creates a job to generate a sequence of raster images that visualize data over a specified time.

Input Parameter Description

NameTypeDescription
attributestringThe animated attribute to map to the video's frames. Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type.
beginstringThe start point for the video. Accepts an expression evaluable over the input parameter attribute.
duration_secondsdoubleSeconds of video to produce
endstringThe end point for the video. Accepts an expression evaluable over the input parameter attribute.
frames_per_seconddoubleThe presentation frame rate of the encoded video in frames per second.
stylestring

The name of the visualize mode; should correspond to the schema used for the input parameter style_parameters field. The supported values are:

  • chart
  • raster
  • classbreak
  • contour
  • heatmap
  • labels
pathstringFully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
style_parametersstringA string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the input parameter style field.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
ttlSets the TTL of the video.
windowSpecified using the data-type corresponding to the input parameter attribute. For a window of size W, a video frame rendered for time t will visualize data in the interval [t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.
no_error_if_exists

If true, does not return an error if the video already exists. Ignored if replace_if_exists is true. The default value is false. The supported values are:

  • false
  • true
replace_if_exists

If true, deletes any existing video with the same path before creating a new video. The default value is false. The supported values are:

  • false
  • true

Output Parameter Description

NameTypeDescription
job_idlongAn identifier for the created job.
pathstringFully qualified KIFS path to the video file.
infomap of string to stringsAdditional information.