A set of parameters for GPUdb::createVideo. More…
#include <gpudb/protocol/create_video.h>
Public Member Functions | |
| CreateVideoRequest () | |
| Constructs a CreateVideoRequest object with default parameters. | |
| CreateVideoRequest (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_) | |
| Constructs a CreateVideoRequest object with the specified parameters. | |
Public Attributes | |
| std::string | attribute |
| The animated attribute to map to the video’s frames. | |
| std::string | begin |
| The start point for the video. | |
| double | durationSeconds |
| Seconds of video to produce. | |
| std::string | end |
| The end point for the video. | |
| double | framesPerSecond |
| The presentation frame rate of the encoded video in frames per second. | |
| std::string | style |
| The name of the visualize mode; should correspond to the schema used for the styleParameters field. | |
| std::string | path |
| Fully-qualified KiFS path. | |
| std::string | styleParameters |
| A string containing the JSON-encoded visualize request. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::createVideo.
Creates a job to generate a sequence of raster images that visualize data over a specified time.
Definition at line 19 of file create_video.h.
Constructor & Destructor Documentation
◆ CreateVideoRequest() [1/2]
| inline |
Constructs a CreateVideoRequest object with default parameters.
Definition at line 24 of file create_video.h.
◆ CreateVideoRequest() [2/2]
| inline |
Constructs a CreateVideoRequest object with the specified 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: |
| [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.
|
Definition at line 140 of file create_video.h.
Member Data Documentation
◆ attribute
| std::string gpudb::CreateVideoRequest::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.
Definition at line 158 of file create_video.h.
◆ begin
| std::string gpudb::CreateVideoRequest::begin |
The start point for the video.
Accepts an expression evaluable over the attribute.
Definition at line 164 of file create_video.h.
◆ durationSeconds
| double gpudb::CreateVideoRequest::durationSeconds |
Seconds of video to produce.
Definition at line 169 of file create_video.h.
◆ end
| std::string gpudb::CreateVideoRequest::end |
The end point for the video.
Accepts an expression evaluable over the attribute.
Definition at line 175 of file create_video.h.
◆ framesPerSecond
| double gpudb::CreateVideoRequest::framesPerSecond |
The presentation frame rate of the encoded video in frames per second.
Definition at line 181 of file create_video.h.
◆ options
| std::map<std::string, std::string> gpudb::CreateVideoRequest::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: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:The default value is create_video_false.
The default value is an empty map.
Definition at line 257 of file create_video.h.
◆ path
| std::string gpudb::CreateVideoRequest::path |
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 206 of file create_video.h.
◆ style
| std::string gpudb::CreateVideoRequest::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
Definition at line 197 of file create_video.h.
◆ styleParameters
| std::string gpudb::CreateVideoRequest::styleParameters |
A string containing the JSON-encoded visualize request.
Must correspond to the visualize mode specified in the style field.
Definition at line 212 of file create_video.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/create_video.h