> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="createVideo(com.gpudb.protocol.CreateVideoRequest)">
        <h3>createVideo</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateVideoResponse" title="class in com.gpudb.protocol">CreateVideoResponse</a></span> <span className="element-name">createVideo</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest" title="class in com.gpudb.protocol">CreateVideoRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Creates a job to generate a sequence of raster images that visualize data over a specified time.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/CreateVideoResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="createVideo(java.lang.String,java.lang.String,double,java.lang.String,double,java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
        <h3>createVideo</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateVideoResponse" title="class in com.gpudb.protocol">CreateVideoResponse</a></span> <span className="element-name">createVideo</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> attribute, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> begin, double durationSeconds, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> end, double framesPerSecond, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> style, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> path, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> styleParameters, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Creates a job to generate a sequence of raster images that visualize data over a specified time.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>attribute</code> - 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.</div>
          <div className="dd"><code>begin</code> - The start point for the video. Accepts an expression evaluable over the <code>attribute</code>.</div>
          <div className="dd"><code>durationSeconds</code> - Seconds of video to produce.</div>
          <div className="dd"><code>end</code> - The end point for the video. Accepts an expression evaluable over the <code>attribute</code>.</div>
          <div className="dd"><code>framesPerSecond</code> - The presentation frame rate of the encoded video in frames per second.</div>

          <div className="dd">
            <code>style</code> - The name of the visualize mode; should correspond to the schema used for the <code>styleParameters</code> field. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#CHART"><code>CHART</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#RASTER"><code>RASTER</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#CLASSBREAK"><code>CLASSBREAK</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#CONTOUR"><code>CONTOUR</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#HEATMAP"><code>HEATMAP</code></a> </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Style#LABELS"><code>LABELS</code></a> </li>
            </ul>
          </div>

          <div className="dd"><code>path</code> - 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 href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#REPLACE_IF_EXISTS"><code>REPLACE\_IF\_EXISTS</code></a> is <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a>.</div>
          <div className="dd"><code>styleParameters</code> - A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the <code>style</code> field.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TTL"><code>TTL</code></a>: Sets the <a href="/content/concepts/ttl" target="_top">TTL</a> of the video. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#WINDOW"><code>WINDOW</code></a>: Specified using the data-type corresponding to the <code>attribute</code>. 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 href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#NO_ERROR_IF_EXISTS"><code>NO\_ERROR\_IF\_EXISTS</code></a>: If <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a>, does not return an error if the video already exists. Ignored if <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#REPLACE_IF_EXISTS"><code>REPLACE\_IF\_EXISTS</code></a> is <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a>. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#FALSE"><code>FALSE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#REPLACE_IF_EXISTS"><code>REPLACE\_IF\_EXISTS</code></a>: If <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a>, deletes any existing video with the same path before creating a new video. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#FALSE"><code>FALSE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#TRUE"><code>TRUE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/CreateVideoRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/CreateVideoResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>