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

# CreateVideoRequest

> CreateVideoRequest — Kinetica JavaScript API

interface CreateVideoRequest \{\
&#x20;[attribute](#attribute): string;\
&#x20;[begin](#begin): string;\
&#x20;[duration\_seconds](#duration_seconds): number;\
&#x20;[end](#end): string;\
&#x20;[frames\_per\_second](#frames_per_second): number;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[path](#path): string;\
&#x20;[style](#style): string;\
&#x20;[style\_parameters](#style_parameters): string;\
}

<ul>
  <li>Defined in [src/types.ts:2153](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2153)</li>
</ul>

##### Index

### Properties

[attribute](#attribute) [begin](#begin) [duration\_seconds](#duration_seconds) [end](#end) [frames\_per\_second](#frames_per_second) [options?](#options) [path](#path) [style](#style) [style\_parameters](#style_parameters)&#x20;

## Properties

### attribute

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.

<ul>
  <li>Defined in [src/types.ts:2155](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2155)</li>
</ul>

### begin

begin: string

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

<ul>
  <li>Defined in [src/types.ts:2157](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2157)</li>
</ul>

### duration\_seconds

duration\_seconds: number

Seconds of video to produce.

<ul>
  <li>Defined in [src/types.ts:2159](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2159)</li>
</ul>

### end

end: string

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

<ul>
  <li>Defined in [src/types.ts:2161](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2161)</li>
</ul>

### frames\_per\_second

frames\_per\_second: number

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

<ul>
  <li>Defined in [src/types.ts:2163](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2163)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:2171](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2171)</li>
</ul>

### path

path: string

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

<ul>
  <li>Defined in [src/types.ts:2167](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2167)</li>
</ul>

### style

style: string

The name of the visualize mode; should correspond to the schema used for the `style_parameters` field.

<ul>
  <li>Defined in [src/types.ts:2165](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2165)</li>
</ul>

### style\_parameters

style\_parameters: string

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

<ul>
  <li>Defined in [src/types.ts:2169](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2169)</li>
</ul>


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