createVideo - Kinetica Docs

◆ createVideo() [1/4]

CreateVideoResponse gpudb::GPUdb::createVideo ( const CreateVideoRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ createVideo() [2/4]

CreateVideoResponse & gpudb::GPUdb::createVideo	(	const CreateVideoRequest &	request_,
		CreateVideoResponse &	response_ ) const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ createVideo() [3/4]

CreateVideoResponse gpudb::GPUdb::createVideo	(	const std::string &	attribute,
		const std::string &	begin,
		const double	durationSeconds,
		const std::string &	end,
		const double	framesPerSecond,
		const std::string &	style,
		const std::string &	path,
		const std::string &	styleParameters,
		const std::map< std::string, std::string > &	options ) const

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

Parameters

[in]	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.
[in]	begin	The start point for the video. Accepts an expression evaluable over the attribute.
[in]	durationSeconds	Seconds of video to produce.
[in]	end	The end point for the video. Accepts an expression evaluable over the attribute.
[in]	framesPerSecond	The presentation frame rate of the encoded video in frames per second.
[in]	style	The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values: create_video_chart create_video_raster create_video_classbreak create_video_contour create_video_heatmap create_video_labels
[in]	path	Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
[in]	styleParameters	A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
[in]	options	Optional parameters. create_video_ttl: Sets the TTL of the video. create_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. create_video_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: create_video_false create_video_true The default value is create_video_false. create_video_replace_if_exists: If true, deletes any existing video with the same path before creating a new video. Supported values: create_video_false create_video_true The default value is create_video_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

◆ createVideo() [4/4]

CreateVideoResponse & gpudb::GPUdb::createVideo	(	const std::string &	attribute,
		const std::string &	begin,
		const double	durationSeconds,
		const std::string &	end,
		const double	framesPerSecond,
		const std::string &	style,
		const std::string &	path,
		const std::string &	styleParameters,
		const std::map< std::string, std::string > &	options,
		CreateVideoResponse &	response_ ) const

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

Parameters

[in]	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.
[in]	begin	The start point for the video. Accepts an expression evaluable over the attribute.
[in]	durationSeconds	Seconds of video to produce.
[in]	end	The end point for the video. Accepts an expression evaluable over the attribute.
[in]	framesPerSecond	The presentation frame rate of the encoded video in frames per second.
[in]	style	The name of the visualize mode; should correspond to the schema used for the styleParameters field. Supported values: create_video_chart create_video_raster create_video_classbreak create_video_contour create_video_heatmap create_video_labels
[in]	path	Fully-qualified KiFS path. Write access is required. A file must not exist at that path, unless replace_if_exists is true.
[in]	styleParameters	A string containing the JSON-encoded visualize request. Must correspond to the visualize mode specified in the style field.
[in]	options	Optional parameters. create_video_ttl: Sets the TTL of the video. create_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. create_video_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: create_video_false create_video_true The default value is create_video_false. create_video_replace_if_exists: If true, deletes any existing video with the same path before creating a new video. Supported values: create_video_false create_video_true The default value is create_video_false. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

​◆ createVideo() [1/4]

​◆ createVideo() [2/4]

​◆ createVideo() [3/4]

​◆ createVideo() [4/4]

◆ createVideo() [1/4]

◆ createVideo() [2/4]

◆ createVideo() [3/4]

◆ createVideo() [4/4]