> ## 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. # kinetica.CreateVideoRequest > kinetica.CreateVideoRequest — Kinetica C# API

A set of parameters for Kinetica.createVideo. More...

Inheritance diagram for kinetica.CreateVideoRequest:
Collaboration diagram for kinetica.CreateVideoRequest:

Classes
struct   Options
  A set of string constants for the parameter CreateVideoRequest.options. More...
 
struct   Style
  A set of string constants for the parameter CreateVideoRequest.style. More...
 

Public Member Functions
  CreateVideoRequest ()
  Constructs a CreateVideoRequest object with default parameters.
 
  CreateVideoRequest (string attribute, string begin, double duration\_seconds, string end, double frames\_per\_second, string style, string path, string style\_parameters, IDictionary\< string, string > options=null)
  Constructs a CreateVideoRequest object with the specified parameters.
 
  CreateVideoRequest ()
  Constructs a CreateVideoRequest object with default parameters.
 
  CreateVideoRequest (string attribute, string begin, double duration\_seconds, string end, double frames\_per\_second, string style, string path, string style\_parameters, IDictionary\< string, string > options=null)
  Constructs a CreateVideoRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  attribute \[get, set]
  The animated attribute to map to the video's frames.
 
string  begin \[get, set]
  The start point for the video.
 
double  duration\_seconds \[get, set]
  Seconds of video to produce.
 
string  end \[get, set]
  The end point for the video.
 
double  frames\_per\_second \[get, set]
  The presentation frame rate of the encoded video in frames per second.
 
string  style \[get, set]
  The name of the visualize mode; should correspond to the schema used for the CreateVideoRequest.style\_parameters field.
 
string  path \[get, set]
  Fully-qualified KiFS path.
 
string  style\_parameters \[get, set]
  A string containing the JSON-encoded visualize request.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.createVideo.

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

Definition at line 16 of file CreateVideo.cs.

Constructor & Destructor Documentation

◆ CreateVideoRequest() \[1/4]

kinetica.CreateVideoRequest.CreateVideoRequest ( )
inline

Constructs a CreateVideoRequest object with default parameters.

Definition at line 269 of file CreateVideo.cs.

◆ CreateVideoRequest() \[2/4]

kinetica.CreateVideoRequest.CreateVideoRequest ( string attribute,
string begin,
double duration\_seconds,
string end,
double frames\_per\_second,
string style,
string path,
string style\_parameters,
IDictionary\< string, string > options = null )
inline

Constructs a CreateVideoRequest object with the specified parameters.

Parameters
attribute 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.
begin The start point for the video. Accepts an expression evaluable over the attribute .
duration\_seconds Seconds of video to produce.
end The end point for the video. Accepts an expression evaluable over the attribute .
frames\_per\_second The presentation frame rate of the encoded video in frames per second.
style The name of the visualize mode; should correspond to the schema used for the style\_parameters field. Supported values:
path Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless REPLACE\_IF\_EXISTS is TRUE.
style\_parameters A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
options Optional 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.

Definition at line 395 of file CreateVideo.cs.

◆ CreateVideoRequest() \[3/4]

kinetica.CreateVideoRequest.CreateVideoRequest ( )
inline

Constructs a CreateVideoRequest object with default parameters.

Definition at line 269 of file CreateVideo.cs.

◆ CreateVideoRequest() \[4/4]

kinetica.CreateVideoRequest.CreateVideoRequest ( string attribute,
string begin,
double duration\_seconds,
string end,
double frames\_per\_second,
string style,
string path,
string style\_parameters,
IDictionary\< string, string > options = null )
inline

Constructs a CreateVideoRequest object with the specified parameters.

Parameters
attribute 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.
begin The start point for the video. Accepts an expression evaluable over the attribute .
duration\_seconds Seconds of video to produce.
end The end point for the video. Accepts an expression evaluable over the attribute .
frames\_per\_second The presentation frame rate of the encoded video in frames per second.
style The name of the visualize mode; should correspond to the schema used for the style\_parameters field. Supported values:
path Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless REPLACE\_IF\_EXISTS is TRUE.
style\_parameters A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
options Optional 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.

Definition at line 395 of file CreateVideo.cs.

Property Documentation

◆ attribute

string kinetica.CreateVideoRequest.attribute
getset

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.

Definition at line 124 of file CreateVideo.cs.

◆ begin

string kinetica.CreateVideoRequest.begin
getset

The start point for the video.

Accepts an expression evaluable over the CreateVideoRequest.attribute.

Definition at line 129 of file CreateVideo.cs.

◆ duration\_seconds

double kinetica.CreateVideoRequest.duration\_seconds
getset

Seconds of video to produce.

Definition at line 132 of file CreateVideo.cs.

◆ end

string kinetica.CreateVideoRequest.end
getset

The end point for the video.

Accepts an expression evaluable over the CreateVideoRequest.attribute.

Definition at line 137 of file CreateVideo.cs.

◆ frames\_per\_second

double kinetica.CreateVideoRequest.frames\_per\_second
getset

The presentation frame rate of the encoded video in frames per second.

Definition at line 141 of file CreateVideo.cs.

◆ options

IDictionary\< string, string > kinetica.CreateVideoRequest.options = new Dictionary\()
getset

Optional parameters.

  • TTL: Sets the TTL of the video.
  • WINDOW: Specified using the data-type corresponding to the CreateVideoRequest.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.

Definition at line 265 of file CreateVideo.cs.

◆ path

string kinetica.CreateVideoRequest.path
getset

Fully-qualified KiFS path.

Write access is required. A file must not exist at that path, unless REPLACE\_IF\_EXISTS is TRUE.

Definition at line 183 of file CreateVideo.cs.

◆ style

string kinetica.CreateVideoRequest.style
getset

The name of the visualize mode; should correspond to the schema used for the CreateVideoRequest.style\_parameters field.

Supported values:

Definition at line 174 of file CreateVideo.cs.

◆ style\_parameters

string kinetica.CreateVideoRequest.style\_parameters
getset

A string containing the JSON-encoded visualize request.

Must correspond to the visualize mode specified in the CreateVideoRequest.style field.

Definition at line 189 of file CreateVideo.cs.

The documentation for this class was generated from the following files: