Creates a job to generate a sequence of raster images that visualize data over
a specified time.
Input Parameter Description
string
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.
string
The start point for the video. Accepts an expression evaluable over the input parameter attribute.
double
Seconds of video to produce.
string
The end point for the video. Accepts an expression evaluable over the input parameter attribute.
double
The presentation frame rate of the encoded video in frames per second.
string
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
string
Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
string
A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the input parameter style field.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
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.
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
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
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘create_video_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/video endpoint:
Show data_str
long
An identifier for the created job.
string
Fully qualified KIFS path to the video file.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.