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

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.create_video"> <span className="sig-name descname"><span className="pre">create\_video</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">attribute</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">begin</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">duration\_seconds</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">end</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">frames\_per\_second</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">style</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">path</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">style\_parameters</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L26322"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <p>Creates a job to generate a sequence of raster images that visualize data over a specified time.</p>
      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl">
            <div className="dt">attribute (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>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.</p>
            </div>

            <div className="dt">begin (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The start point for the video. Accepts an expression evaluable over the input parameter <span className="em">attribute</span>.</p>
            </div>

            <div className="dt">duration\_seconds (<span className="em">float</span>) –</div>

            <div className="dd">
              <p>Seconds of video to produce.</p>
            </div>

            <div className="dt">end (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The end point for the video. Accepts an expression evaluable over the input parameter <span className="em">attribute</span>.</p>
            </div>

            <div className="dt">frames\_per\_second (<span className="em">float</span>) –</div>

            <div className="dd">
              <p>The presentation frame rate of the encoded video in frames per second.</p>
            </div>

            <div className="dt">style (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The name of the visualize mode; should correspond to the schema used for the input parameter <span className="em">style\_parameters</span> field. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>chart</p>
                </li>

                <li>
                  <p>raster</p>
                </li>

                <li>
                  <p>classbreak</p>
                </li>

                <li>
                  <p>contour</p>
                </li>

                <li>
                  <p>heatmap</p>
                </li>

                <li>
                  <p>labels</p>
                </li>
              </ul>
            </div>

            <div className="dt">path (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Fully-qualified <a className="reference external" href="/content/tools/kifs/">KiFS</a> path. Write access is required. A file must not exist at that path, unless <span className="em">replace\_if\_exists</span> is <span className="em">true</span>.</p>
            </div>

            <div className="dt">style\_parameters (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the input parameter <span className="em">style</span> field.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. Allowed keys are:</p>

              <ul>
                <li>
                  <p><strong>ttl</strong> – Sets the <a className="reference external" href="/content/concepts/ttl">TTL</a> of the video.</p>
                </li>

                <li>
                  <p><strong>window</strong> – Specified using the data-type corresponding to the input parameter <span className="em">attribute</span>. For a window of size W, a video frame rendered for time t will visualize data in the interval \[t-W,t]. The minimum window size is the interval between successive frames. The minimum value is the default. If a value less than the minimum value is specified, it is replaced with the minimum window size. Larger values will make changes throughout the video appear more smooth while smaller values will capture fast variations in the data.</p>
                </li>

                <li>
                  <p><strong>no\_error\_if\_exists</strong> – If <span className="em">true</span>, does not return an error if the video already exists. Ignored if <span className="em">replace\_if\_exists</span> is <span className="em">true</span>. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p>false</p>
                    </li>

                    <li>
                      <p>true</p>
                    </li>
                  </ul>

                  <p>The default value is ‘false’.</p>
                </li>

                <li>
                  <p><strong>replace\_if\_exists</strong> – If <span className="em">true</span>, deletes any existing video with the same path before creating a new video. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p>false</p>
                    </li>

                    <li>
                      <p>true</p>
                    </li>
                  </ul>

                  <p>The default value is ‘false’.</p>
                </li>
              </ul>

              <p>The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">job\_id (<span className="em">long</span>) –</div>

            <div className="dd">
              <p>An identifier for the created job.</p>
            </div>

            <div className="dt">path (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Fully qualified KIFS path to the video file.</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>