Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.CreateVideoRequest.Options Struct Reference

Optional parameters. 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

Optional parameters.

  • TTL: Sets the TTL of the video.
  • WINDOW: Specified using the data-type corresponding to the . 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. A set of string constants for the parameter options.

Definition at line 130 of file CreateVideo.cs.

Member Data Documentation

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

Definition at line 165 of file CreateVideo.cs.

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.

Ignored if replace_if_exists is true. Supported values:

The default value is FALSE.

Definition at line 164 of file CreateVideo.cs.

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 183 of file CreateVideo.cs.

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

Definition at line 166 of file CreateVideo.cs.

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

Sets the TTL of the video.

Definition at line 135 of file CreateVideo.cs.

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 146 of file CreateVideo.cs.

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