Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateVideoRequest Class Reference

A set of parameters for Kinetica.createVideo(string,string,double,string,double,string,string,string,IDictionary{string, string}). More...

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

Classes

struct  Options
 Optional parameters. More...
 
struct  Style
 The name of the visualize mode; should correspond to the schema used for the field. More...
 

Public Member Functions

 CreateVideoRequest ()
 Constructs a CreateVideoRequest object with default parameters. More...
 
 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. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

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

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. More...
 

Detailed Description

A set of parameters for Kinetica.createVideo(string,string,double,string,double,string,string,string,IDictionary{string, string}).


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

Definition at line 20 of file CreateVideo.cs.

Constructor & Destructor Documentation

kinetica.CreateVideoRequest.CreateVideoRequest ( )
inline

Constructs a CreateVideoRequest object with default parameters.

Definition at line 319 of file CreateVideo.cs.

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
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 .
duration_secondsSeconds of video to produce
endThe end point for the video. Accepts an expression evaluable over the .
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 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 field.
optionsOptional 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.

Definition at line 439 of file CreateVideo.cs.

Property Documentation

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

string kinetica.CreateVideoRequest.begin
getset

The start point for the video.

Accepts an expression evaluable over the .

Definition at line 195 of file CreateVideo.cs.

double kinetica.CreateVideoRequest.duration_seconds
getset

Seconds of video to produce

Definition at line 198 of file CreateVideo.cs.

string kinetica.CreateVideoRequest.end
getset

The end point for the video.

Accepts an expression evaluable over the .

Definition at line 203 of file CreateVideo.cs.

double kinetica.CreateVideoRequest.frames_per_second
getset

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

Definition at line 207 of file CreateVideo.cs.

IDictionary<string, string> kinetica.CreateVideoRequest.options
getset

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.

Definition at line 314 of file CreateVideo.cs.

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

string kinetica.CreateVideoRequest.style
getset

The name of the visualize mode; should correspond to the schema used for the field.

Supported values:

Definition at line 239 of file CreateVideo.cs.

string kinetica.CreateVideoRequest.style_parameters
getset

A string containing the JSON-encoded visualize request.

Must correspond to the visualize mode specified in the field.

Definition at line 250 of file CreateVideo.cs.


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