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

### create\_video

<ul>
  <li>
    create\_video(\
    &#x20;attribute: string,\
    &#x20;begin: string,\
    &#x20;duration\_seconds: number,\
    &#x20;end: string,\
    &#x20;frames\_per\_second: number,\
    &#x20;style: string,\
    &#x20;path: string,\
    &#x20;style\_parameters: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[CreateVideoResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoResponse.md)>

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

    #### Parameters

    <ul>
      <li>
        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.
      </li>

      <li>
        begin: string

        The start point for the video. Accepts an expression evaluable over the `attribute`.
      </li>

      <li>
        duration\_seconds: number

        Seconds of video to produce.
      </li>

      <li>
        end: string

        The end point for the video. Accepts an expression evaluable over the `attribute`.
      </li>

      <li>
        frames\_per\_second: number

        The presentation frame rate of the encoded video in frames per second.
      </li>

      <li>
        style: string

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

      <li>
        path: string

        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: string

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

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateVideoResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoResponse.md)>

    Promise\<Types.CreateVideoResponse> - Promise resolving to the response

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

### create\_video\_request

<ul>
  <li>
    create\_video\_request(\
    &#x20;request: [CreateVideoRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[CreateVideoResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoResponse.md)>

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

    #### Parameters

    <ul>
      <li>
        request: [CreateVideoRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateVideoResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/CreateVideoResponse.md)>

    Promise\<Types.CreateVideoResponse> - Promise resolving to the response

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


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