Skip to main content
Source

pub async fn create_video( &self, attribute: String, begin: String, duration_seconds: f64, end: String, frames_per_second: f64, style: String, path: String, style_parameters: String, ) -> Result<CreateVideoResponse, KineticaError>

Create a video.

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

  • attribute - 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 - The start point for the video. Accepts an expression evaluable over the attribute.
  • duration_seconds - Seconds of video to produce.
  • end - The end point for the video. Accepts an expression evaluable over the attribute.
  • frames_per_second - The presentation frame rate of the encoded video in frames per second.
  • style - The name of the visualize mode; should correspond to the schema used for the style_parameters field.
  • path - Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
  • style_parameters - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
Source

pub async fn create_video_with_opts( &self, attribute: String, begin: String, duration_seconds: f64, end: String, frames_per_second: f64, style: String, path: String, style_parameters: String, options: CreateVideoRequestOptions, ) -> Result<CreateVideoResponse, KineticaError>

Create a video.

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

  • attribute - 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 - The start point for the video. Accepts an expression evaluable over the attribute.
  • duration_seconds - Seconds of video to produce.
  • end - The end point for the video. Accepts an expression evaluable over the attribute.
  • frames_per_second - The presentation frame rate of the encoded video in frames per second.
  • style - The name of the visualize mode; should correspond to the schema used for the style_parameters field.
  • path - Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
  • style_parameters - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
  • options - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built CreateVideoRequest to the /create/video endpoint.

Sends a pre-built CreateVideoRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.