Skip to main content
URL: http://<db.host>:<db.port>/create/video
Creates a job to generate a sequence of raster images that visualize data over a specified time.

​
Input Parameter Description

​
attribute
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.
​
begin
string
The start point for the video. Accepts an expression evaluable over the input parameter attribute.
​
duration_seconds
double
Seconds of video to produce.
​
end
string
The end point for the video. Accepts an expression evaluable over the input parameter attribute.
​
frames_per_second
double
The presentation frame rate of the encoded video in frames per second.
​
style
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
​
path
string
Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
​
style_parameters
string
A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the input parameter style field.
​
options
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
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:
​
status
String
‘OK’ or ‘ERROR’
​
message
String
Empty if success or an error message
​
data_type
String
‘create_video_response’ or ‘none’ in case of an error
​
data
String
Empty string
​
data_str
JSON or String
This embedded JSON represents the result of the /create/video endpoint:Empty string in case of an error.