Skip to main content

​
◆ createVideo() [1/2]

CreateVideoResponse kinetica.Kinetica.createVideo (CreateVideoRequestrequest_)
 inline

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 31192 of file KineticaFunctions.cs.

​
◆ createVideo() [2/2]

CreateVideoResponse kinetica.Kinetica.createVideo (stringattribute,
stringbegin,
doubleduration_seconds,
stringend,
doubleframes_per_second,
stringstyle,
stringpath,
stringstyle_parameters,
IDictionary< string, string >options = null )
 inline

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

Parameters
attributeThe 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.
beginThe start point for the video. Accepts an expression evaluable over the attribute .
duration_secondsSeconds of video to produce.
endThe end point for the video. Accepts an expression evaluable over the attribute .
frames_per_secondThe presentation frame rate of the encoded video in frames per second.
styleThe name of the visualize mode; should correspond to the schema used for the style_parameters field. Supported values:
pathFully-qualified KiFS path. Write access is required. A file must not exist at that path, unless REPLACE_IF_EXISTS is TRUE.
style_parametersA string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
optionsOptional parameters.
  • TTL: Sets the TTL of the video.
  • WINDOW: Specified using the data-type corresponding to the attribute . 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.
  • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the video already exists. Ignored if REPLACE_IF_EXISTS is TRUE. Supported values:The default value is FALSE.
  • REPLACE_IF_EXISTS: If TRUE, deletes any existing video with the same path before creating a new video. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 31342 of file KineticaFunctions.cs.

​
◆ CreateVideoAsync() [1/2]

async System.Threading.Tasks.Task< CreateVideoResponse > kinetica.Kinetica.CreateVideoAsync (CreateVideoRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 31208 of file KineticaFunctions.cs.

​
◆ CreateVideoAsync() [2/2]

async System.Threading.Tasks.Task< CreateVideoResponse > kinetica.Kinetica.CreateVideoAsync (stringattribute,
stringbegin,
doubleduration_seconds,
stringend,
doubleframes_per_second,
stringstyle,
stringpath,
stringstyle_parameters,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

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

(async)

Parameters
attributeThe 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.
beginThe start point for the video. Accepts an expression evaluable over the attribute .
duration_secondsSeconds of video to produce.
endThe end point for the video. Accepts an expression evaluable over the attribute .
frames_per_secondThe presentation frame rate of the encoded video in frames per second.
styleThe name of the visualize mode; should correspond to the schema used for the style_parameters field. Supported values:
pathFully-qualified KiFS path. Write access is required. A file must not exist at that path, unless REPLACE_IF_EXISTS is TRUE.
style_parametersA string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
optionsOptional parameters.
  • TTL: Sets the TTL of the video.
  • WINDOW: Specified using the data-type corresponding to the attribute . 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.
  • NO_ERROR_IF_EXISTS: If TRUE, does not return an error if the video already exists. Ignored if REPLACE_IF_EXISTS is TRUE. Supported values:The default value is FALSE.
  • REPLACE_IF_EXISTS: If TRUE, deletes any existing video with the same path before creating a new video. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 31485 of file KineticaFunctions.cs.