create_video

The 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.

The start point for the video. Accepts an expression evaluable over the input parameter attribute.

Seconds of video to produce.

The end point for the video. Accepts an expression evaluable over the input parameter attribute.

The presentation frame rate of the encoded video in frames per second.

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

• chart

• raster

• classbreak

• contour

• heatmap

• labels

Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.

A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the input parameter style field.

Optional parameters. Allowed keys are:

• ttl – Sets the TTL of the video.

• window – Specified 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. Allowed values are:

  • false

  • true

  The default value is ‘false’.

• replace_if_exists – If true, deletes any existing video with the same path before creating a new video. Allowed values are:

  • false

  • true

  The default value is ‘false’.

The default value is an empty dict ( ).