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

struct	Style
	A set of string constants for the parameter style. 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...

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

	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 style_parameters 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 = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

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

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.

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 219 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: CHART RASTER CLASSBREAK CONTOUR HEATMAP LABELS
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: FALSE TRUE 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: FALSE TRUE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 331 of file CreateVideo.cs.

◆ CreateVideoRequest() [3/4]

kinetica.CreateVideoRequest.CreateVideoRequest ( )

inline

Constructs a CreateVideoRequest object with default parameters.

Definition at line 219 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: CHART RASTER CLASSBREAK CONTOUR HEATMAP LABELS
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: FALSE TRUE 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: FALSE TRUE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 331 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 94 of file CreateVideo.cs.

◆ begin

string kinetica.CreateVideoRequest.begin

getset

The start point for the video.

Accepts an expression evaluable over the attribute.

Definition at line 99 of file CreateVideo.cs.

◆ duration_seconds

double kinetica.CreateVideoRequest.duration_seconds

getset

Seconds of video to produce

Definition at line 102 of file CreateVideo.cs.

◆ end

string kinetica.CreateVideoRequest.end

getset

The end point for the video.

Accepts an expression evaluable over the attribute.

Definition at line 107 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 111 of file CreateVideo.cs.

◆ options

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

getset

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:
- FALSE
- TRUE
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:
- FALSE
- TRUE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 215 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 145 of file CreateVideo.cs.

◆ style

string kinetica.CreateVideoRequest.style

getset

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

Supported values:

Definition at line 137 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 style field.

Definition at line 151 of file CreateVideo.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateVideo.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateVideoRequest() [1/4]

◆ CreateVideoRequest() [2/4]

◆ CreateVideoRequest() [3/4]

◆ CreateVideoRequest() [4/4]

Property Documentation

◆ attribute

◆ begin

◆ duration_seconds

◆ end

◆ frames_per_second

◆ options

◆ path

◆ style

◆ style_parameters