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

# gpudb::CreateVideoRequest

> gpudb::CreateVideoRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ae81d077f831f4e98c69ea0a58be83c32">GPUdb::createVideo</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__video_8h_source">gpudb/protocol/create\_video.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:af8ba71ede11cb7e4a64fcf502b397175" id="r_af8ba71ede11cb7e4a64fcf502b397175">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af8ba71ede11cb7e4a64fcf502b397175">CreateVideoRequest</a> ()</td>
      </tr>

      <tr className="memdesc:af8ba71ede11cb7e4a64fcf502b397175">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest" title="A set of parameters for GPUdb::createVideo.">CreateVideoRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:af8ba71ede11cb7e4a64fcf502b397175">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a89ef150bc292e7216655f1e089a8377d" id="r_a89ef150bc292e7216655f1e089a8377d">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a89ef150bc292e7216655f1e089a8377d">CreateVideoRequest</a> (const std::string \&attribute\_, const std::string \&begin\_, const double durationSeconds\_, const std::string \&end\_, const double framesPerSecond\_, const std::string \&style\_, const std::string \&path\_, const std::string \&styleParameters\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a89ef150bc292e7216655f1e089a8377d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest" title="A set of parameters for GPUdb::createVideo.">CreateVideoRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a89ef150bc292e7216655f1e089a8377d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:acd2420158abc41ee3f8b9b29a7cab066" id="r_acd2420158abc41ee3f8b9b29a7cab066">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acd2420158abc41ee3f8b9b29a7cab066">attribute</a></td>
      </tr>

      <tr className="memdesc:acd2420158abc41ee3f8b9b29a7cab066">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The animated attribute to map to the video's frames. <br /></td>
      </tr>

      <tr className="separator:acd2420158abc41ee3f8b9b29a7cab066">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ae001b0b2db6fb982f7d145ad88971311" id="r_ae001b0b2db6fb982f7d145ad88971311">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae001b0b2db6fb982f7d145ad88971311">begin</a></td>
      </tr>

      <tr className="memdesc:ae001b0b2db6fb982f7d145ad88971311">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The start point for the video. <br /></td>
      </tr>

      <tr className="separator:ae001b0b2db6fb982f7d145ad88971311">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad7acff65d12d34aa9260580db56d9ca8" id="r_ad7acff65d12d34aa9260580db56d9ca8">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad7acff65d12d34aa9260580db56d9ca8">durationSeconds</a></td>
      </tr>

      <tr className="memdesc:ad7acff65d12d34aa9260580db56d9ca8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Seconds of video to produce. <br /></td>
      </tr>

      <tr className="separator:ad7acff65d12d34aa9260580db56d9ca8">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a249a8091865aa40571d5132211619945" id="r_a249a8091865aa40571d5132211619945">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a249a8091865aa40571d5132211619945">end</a></td>
      </tr>

      <tr className="memdesc:a249a8091865aa40571d5132211619945">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The end point for the video. <br /></td>
      </tr>

      <tr className="separator:a249a8091865aa40571d5132211619945">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:af2ecb1c9522265ad970d73c914afbcd7" id="r_af2ecb1c9522265ad970d73c914afbcd7">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af2ecb1c9522265ad970d73c914afbcd7">framesPerSecond</a></td>
      </tr>

      <tr className="memdesc:af2ecb1c9522265ad970d73c914afbcd7">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The presentation frame rate of the encoded video in frames per second. <br /></td>
      </tr>

      <tr className="separator:af2ecb1c9522265ad970d73c914afbcd7">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:afc8ae1bf42a3219cb39912e30e342488" id="r_afc8ae1bf42a3219cb39912e30e342488">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#afc8ae1bf42a3219cb39912e30e342488">style</a></td>
      </tr>

      <tr className="memdesc:afc8ae1bf42a3219cb39912e30e342488">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The name of the visualize mode; should correspond to the schema used for the <a className="el" href="#a7310dc8f686d8f14054fb6d210ed15c2">styleParameters</a> field. <br /></td>
      </tr>

      <tr className="separator:afc8ae1bf42a3219cb39912e30e342488">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a3510764998a4f24f20c9b91b5f366eb2" id="r_a3510764998a4f24f20c9b91b5f366eb2">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3510764998a4f24f20c9b91b5f366eb2">path</a></td>
      </tr>

      <tr className="memdesc:a3510764998a4f24f20c9b91b5f366eb2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Fully-qualified <a href="/content/tools/kifs/" target="_top">KiFS</a> path. <br /></td>
      </tr>

      <tr className="separator:a3510764998a4f24f20c9b91b5f366eb2">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a7310dc8f686d8f14054fb6d210ed15c2" id="r_a7310dc8f686d8f14054fb6d210ed15c2">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7310dc8f686d8f14054fb6d210ed15c2">styleParameters</a></td>
      </tr>

      <tr className="memdesc:a7310dc8f686d8f14054fb6d210ed15c2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A string containing the JSON-encoded visualize request. <br /></td>
      </tr>

      <tr className="separator:a7310dc8f686d8f14054fb6d210ed15c2">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a073cc761d08e89af60b0cf5c3e314816" id="r_a073cc761d08e89af60b0cf5c3e314816">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a073cc761d08e89af60b0cf5c3e314816">options</a></td>
      </tr>

      <tr className="memdesc:a073cc761d08e89af60b0cf5c3e314816">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a073cc761d08e89af60b0cf5c3e314816">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#ae81d077f831f4e98c69ea0a58be83c32">GPUdb::createVideo</a>. </p>
      <p>Creates a job to generate a sequence of raster images that visualize data over a specified time. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#af8ba71ede11cb7e4a64fcf502b397175">◆ </a></span>CreateVideoRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateVideoRequest::CreateVideoRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest" title="A set of parameters for GPUdb::createVideo.">CreateVideoRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateVideoRequest::CreateVideoRequest </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>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateVideoRequest" title="A set of parameters for GPUdb::createVideo.">CreateVideoRequest</a> object with the specified parameters. </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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00140">140</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#acd2420158abc41ee3f8b9b29a7cab066">◆ </a></span>attribute</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::attribute</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The animated attribute to map to the video's frames. </p>
        <p>Must be present in the LAYERS specified for the visualization. This is often a time-related field but may be any numeric type. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00158">158</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae001b0b2db6fb982f7d145ad88971311">◆ </a></span>begin</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::begin</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The start point for the video. </p>
        <p>Accepts an expression evaluable over the <a className="el" href="#acd2420158abc41ee3f8b9b29a7cab066">attribute</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00164">164</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad7acff65d12d34aa9260580db56d9ca8">◆ </a></span>durationSeconds</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::CreateVideoRequest::durationSeconds</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Seconds of video to produce. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00169">169</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a249a8091865aa40571d5132211619945">◆ </a></span>end</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::end</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The end point for the video. </p>
        <p>Accepts an expression evaluable over the <a className="el" href="#acd2420158abc41ee3f8b9b29a7cab066">attribute</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00175">175</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af2ecb1c9522265ad970d73c914afbcd7">◆ </a></span>framesPerSecond</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::CreateVideoRequest::framesPerSecond</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The presentation frame rate of the encoded video in frames per second. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00181">181</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a073cc761d08e89af60b0cf5c3e314816">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateVideoRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <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 <a className="el" href="#acd2420158abc41ee3f8b9b29a7cab066">attribute</a>. 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>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00257">257</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a3510764998a4f24f20c9b91b5f366eb2">◆ </a></span>path</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::path</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Fully-qualified <a href="/content/tools/kifs/" target="_top">KiFS</a> path. </p>
        <p>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>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00206">206</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#afc8ae1bf42a3219cb39912e30e342488">◆ </a></span>style</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::style</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The name of the visualize mode; should correspond to the schema used for the <a className="el" href="#a7310dc8f686d8f14054fb6d210ed15c2">styleParameters</a> field. </p>
        <p>Supported values: </p>

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

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00197">197</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7310dc8f686d8f14054fb6d210ed15c2">◆ </a></span>styleParameters</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateVideoRequest::styleParameters</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A string containing the JSON-encoded visualize request. </p>
        <p>Must correspond to the visualize mode specified in the <a className="el" href="#afc8ae1bf42a3219cb39912e30e342488">style</a> field. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__video_8h_source#l00212">212</a> of file <a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/create__video_8h_source">create\_video.h</a></li>
    </ul>
  </div>
</div>
