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

# createVideo

<div className="kinetica-doxygen">
  <div id="ae81d077f831f4e98c69ea0a58be83c32" />

  <h2 className="memtitle"><span className="permalink"><a href="#ae81d077f831f4e98c69ea0a58be83c32">◆ </a></span>createVideo() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> gpudb::GPUdb::createVideo </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest">CreateVideoRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

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

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="ab496488e5c4fe83f0974f79c0f222fe8" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab496488e5c4fe83f0974f79c0f222fe8">◆ </a></span>createVideo() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> & gpudb::GPUdb::createVideo </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest">CreateVideoRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

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

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="af14dc5b767384075f16aa02a1ede6f0d" />

  <h2 className="memtitle"><span className="permalink"><a href="#af14dc5b767384075f16aa02a1ede6f0d">◆ </a></span>createVideo() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> gpudb::GPUdb::createVideo </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">attribute</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">begin</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">durationSeconds</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">end</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">framesPerSecond</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">style</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">path</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">styleParameters</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</td>
        </tr>
      </table>
    </div>

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

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">attribute</td>
              <td>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. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">begin</td>
              <td>The start point for the video. Accepts an expression evaluable over the <span className="em arg">attribute</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">durationSeconds</td>
              <td>Seconds of video to produce. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">end</td>
              <td>The end point for the video. Accepts an expression evaluable over the <span className="em arg">attribute</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">framesPerSecond</td>
              <td>The presentation frame rate of the encoded video in frames per second. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">style</td>

              <td>
                The name of the visualize mode; should correspond to the schema used for the <span className="em arg">styleParameters</span> field. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe152a971e8d3f8e5418c6502636c284">create\_video\_chart</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a100965ab532f8518724480de468d89e5">create\_video\_raster</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3a76afa5f92387e7c724911d767856d6">create\_video\_classbreak</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4d22d6c9e12c770a3a04d54917a8fa09">create\_video\_contour</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a35721de038587daf4a395a07a5a658b5">create\_video\_heatmap</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5e3bd88a0e45f33c240e3e42286fe77">create\_video\_labels</a> </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">path</td>
              <td>Fully-qualified <a href="/content/tools/kifs/" target="_top">KiFS</a> path. Write access is required. A file must not exist at that path, unless <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">replace\_if\_exists</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">styleParameters</td>
              <td>A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the <span className="em arg">style</span> field. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a78f0c862fbe5ec9838929877d26abf0a">create\_video\_ttl</a>: Sets the <a href="/content/concepts/ttl" target="_top">TTL</a> of the video. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa50ce6b5c3a5889a951aba21195e770f">create\_video\_window</a>: Specified using the data-type corresponding to the <span className="em arg">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. </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a6be638b7a0100fa3a132dd8ea971cec1">create\_video\_no\_error\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>, does not return an error if the video already exists. Ignored if <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">replace\_if\_exists</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">create\_video\_true</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">create\_video\_replace\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>, deletes any existing video with the same path before creating a new video. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">create\_video\_true</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a>.
                  </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a7fdf6087dc9b6b89564696f7e7a2a8b0" />

  <h2 className="memtitle"><span className="permalink"><a href="#a7fdf6087dc9b6b89564696f7e7a2a8b0">◆ </a></span>createVideo() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> & gpudb::GPUdb::createVideo </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">attribute</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">begin</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">durationSeconds</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">end</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const double</td>
          <td className="paramname"><span className="paramname"><span className="em">framesPerSecond</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">style</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">path</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">styleParameters</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">CreateVideoResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

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

      <div className="dl params">
        <div className="dt">Parameters</div>

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">attribute</td>
              <td>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. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">begin</td>
              <td>The start point for the video. Accepts an expression evaluable over the <span className="em arg">attribute</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">durationSeconds</td>
              <td>Seconds of video to produce. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">end</td>
              <td>The end point for the video. Accepts an expression evaluable over the <span className="em arg">attribute</span>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">framesPerSecond</td>
              <td>The presentation frame rate of the encoded video in frames per second. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">style</td>

              <td>
                The name of the visualize mode; should correspond to the schema used for the <span className="em arg">styleParameters</span> field. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe152a971e8d3f8e5418c6502636c284">create\_video\_chart</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a100965ab532f8518724480de468d89e5">create\_video\_raster</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3a76afa5f92387e7c724911d767856d6">create\_video\_classbreak</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4d22d6c9e12c770a3a04d54917a8fa09">create\_video\_contour</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a35721de038587daf4a395a07a5a658b5">create\_video\_heatmap</a> </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5e3bd88a0e45f33c240e3e42286fe77">create\_video\_labels</a> </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">path</td>
              <td>Fully-qualified <a href="/content/tools/kifs/" target="_top">KiFS</a> path. Write access is required. A file must not exist at that path, unless <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">replace\_if\_exists</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">styleParameters</td>
              <td>A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the <span className="em arg">style</span> field. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a78f0c862fbe5ec9838929877d26abf0a">create\_video\_ttl</a>: Sets the <a href="/content/concepts/ttl" target="_top">TTL</a> of the video. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa50ce6b5c3a5889a951aba21195e770f">create\_video\_window</a>: Specified using the data-type corresponding to the <span className="em arg">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. </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a6be638b7a0100fa3a132dd8ea971cec1">create\_video\_no\_error\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>, does not return an error if the video already exists. Ignored if <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">replace\_if\_exists</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">create\_video\_true</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a6bf126d03476b8e410bd863be494b799">create\_video\_replace\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">true</a>, deletes any existing video with the same path before creating a new video. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a101a81ee5c9040cdc1f899fee4a2575b">create\_video\_true</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a80a3fba66a887d5d9512580e0fd8be68">create\_video\_false</a>.
                  </li>
                </ul>

                The default value is an empty map.
              </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>