> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# create_video

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_video.rs#L36-L59)
pub async fn [create\_video](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-video.md#method.create_video)( \&self, attribute: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), begin: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), duration\_seconds: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), end: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), frames\_per\_second: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), style: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), path: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), style\_parameters: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateVideoResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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

##### Arguments

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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_video.rs#L87-L117)
pub async fn [create\_video\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-video.md#method.create_video_with_opts)( \&self, attribute: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), begin: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), duration\_seconds: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), end: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), frames\_per\_second: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), style: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), path: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), style\_parameters: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), options: [CreateVideoRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateVideoResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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

##### Arguments

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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_video.rs#L120-L131)
pub async fn [create\_video\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-video.md#method.create_video_raw)( \&self, request: &[CreateVideoRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateVideoResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`CreateVideoRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoRequest) to the `/create/video` endpoint.

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_video.rs#L135-L147)
pub async fn [create\_video\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-video.md#method.create_video_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[CreateVideoRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateVideoResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`CreateVideoRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateVideoRequest) to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.