Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
CreateVideo.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
21  {
22 
55  public struct Style
56  {
57  public const string CHART = "chart";
58  public const string RASTER = "raster";
59  public const string CLASSBREAK = "classbreak";
60  public const string CONTOUR = "contour";
61  public const string HEATMAP = "heatmap";
62  public const string LABELS = "labels";
63  } // end struct Style
64 
65 
130  public struct Options
131  {
132 
135  public const string TTL = "ttl";
136 
146  public const string WINDOW = "window";
147 
164  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
165  public const string FALSE = "false";
166  public const string TRUE = "true";
167 
183  public const string REPLACE_IF_EXISTS = "replace_if_exists";
184  } // end struct Options
185 
186 
190  public string attribute { get; set; }
191 
195  public string begin { get; set; }
196 
198  public double duration_seconds { get; set; }
199 
203  public string end { get; set; }
204 
207  public double frames_per_second { get; set; }
208 
239  public string style { get; set; }
240 
245  public string path { get; set; }
246 
250  public string style_parameters { get; set; }
251 
314  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
315 
316 
319  public CreateVideoRequest() { }
320 
440  string begin,
441  double duration_seconds,
442  string end,
443  double frames_per_second,
444  string style,
445  string path,
446  string style_parameters,
447  IDictionary<string, string> options = null)
448  {
449  this.attribute = attribute ?? "";
450  this.begin = begin ?? "";
451  this.duration_seconds = duration_seconds;
452  this.end = end ?? "";
453  this.frames_per_second = frames_per_second;
454  this.style = style ?? "";
455  this.path = path ?? "";
456  this.style_parameters = style_parameters ?? "";
457  this.options = options ?? new Dictionary<string, string>();
458  } // end constructor
459 
460  } // end class CreateVideoRequest
461 
462 
463 
468  {
469 
471  public long job_id { get; set; }
472 
474  public string path { get; set; }
475 
477  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
478 
479  } // end class CreateVideoResponse
480 
481 
482 
483 
484 } // end namespace kinetica
CreateVideoRequest()
Constructs a CreateVideoRequest object with default parameters.
Definition: CreateVideo.cs:319
IDictionary< string, string > options
Optional parameters.
Definition: CreateVideo.cs:314
string begin
The start point for the video.
Definition: CreateVideo.cs:195
const string WINDOW
Specified using the data-type corresponding to the attribute.
Definition: CreateVideo.cs:146
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.
Definition: CreateVideo.cs:439
long job_id
An identifier for the created job.
Definition: CreateVideo.cs:471
double duration_seconds
Seconds of video to produce
Definition: CreateVideo.cs:198
The name of the visualize mode; should correspond to the schema used for the field.
Definition: CreateVideo.cs:55
string path
Fully qualified KIFS path to the video file.
Definition: CreateVideo.cs:474
const string REPLACE_IF_EXISTS
If true, deletes any existing video with the same path before creating a new video.
Definition: CreateVideo.cs:183
string end
The end point for the video.
Definition: CreateVideo.cs:203
A set of results returned by Kinetica.createVideo(string,string,double,string,double,string,string,string,IDictionary{string, string}).
Definition: CreateVideo.cs:467
string attribute
The animated attribute to map to the video&#39;s frames.
Definition: CreateVideo.cs:190
const string NO_ERROR_IF_EXISTS
If true, does not return an error if the video already exists.
Definition: CreateVideo.cs:164
string path
Fully-qualified KiFS path.
Definition: CreateVideo.cs:245
double frames_per_second
The presentation frame rate of the encoded video in frames per second.
Definition: CreateVideo.cs:207
A set of parameters for Kinetica.createVideo(string,string,double,string,double,string,string,string,IDictionary{string, string}).
Definition: CreateVideo.cs:20
IDictionary< string, string > info
Additional information.
Definition: CreateVideo.cs:477
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string style_parameters
A string containing the JSON-encoded visualize request.
Definition: CreateVideo.cs:250
const string TTL
Sets the TTL of the video.
Definition: CreateVideo.cs:135
string style
The name of the visualize mode; should correspond to the schema used for the field.
Definition: CreateVideo.cs:239