Kinetica   C#   API  Version 7.2.3.0
kinetica.CreateVideoRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string TTL = "ttl"
 Sets the TTL of the video. More...
 
const string WINDOW = "window"
 Specified using the data-type corresponding to the attribute. More...
 
const string NO_ERROR_IF_EXISTS = "no_error_if_exists"
 If TRUE, does not return an error if the video already exists. More...
 
const string FALSE = "false"
 
const string TRUE = "true"
 
const string REPLACE_IF_EXISTS = "replace_if_exists"
 If TRUE, deletes any existing video with the same path before creating a new video. More...
 

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 36 of file CreateVideo.cs.

Member Data Documentation

◆ FALSE

const string kinetica.CreateVideoRequest.Options.FALSE = "false"

Definition at line 69 of file CreateVideo.cs.

◆ NO_ERROR_IF_EXISTS

const string kinetica.CreateVideoRequest.Options.NO_ERROR_IF_EXISTS = "no_error_if_exists"

If TRUE, does not return an error if the video already exists.

Supported values:

The default value is FALSE.

Definition at line 67 of file CreateVideo.cs.

◆ REPLACE_IF_EXISTS

const string kinetica.CreateVideoRequest.Options.REPLACE_IF_EXISTS = "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.

Definition at line 86 of file CreateVideo.cs.

◆ TRUE

const string kinetica.CreateVideoRequest.Options.TRUE = "true"

Definition at line 70 of file CreateVideo.cs.

◆ TTL

const string kinetica.CreateVideoRequest.Options.TTL = "ttl"

Sets the TTL of the video.

Definition at line 40 of file CreateVideo.cs.

◆ WINDOW

const string kinetica.CreateVideoRequest.Options.WINDOW = "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.

Definition at line 52 of file CreateVideo.cs.


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