gpudb::VisualizeVideoResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/visualize_video.h>

Public Member Functions
	VisualizeVideoResponse ()
	Constructs a VisualizeVideoResponse object with default parameter values. More...

Public Attributes
double	width
double	height
int64_t	bgColor
int32_t	numFrames
std::string	sessionKey
std::vector< std::vector < uint8_t > >	data

Detailed Description

A set of output parameters for const.

Creates raster images of data in the given table based on provided input parameters. Numerous parameters are required to call this function. Some of the important parameters are the attributes of the generated images (bgColor, width, height), the collection of table names on which this function is to be applied, for which shapes (point, polygon, tracks) the images are to be created and a user specified session key. This session key is later used to fetch the generated images. The operation is synchronous, meaning that a response will not be returned until the images for all the frames of the video are fully available.

Once the request has been processed then the generated video frames are available for download via WMS using STYLES=cached. In this request the LAYERS parameter should be populated with the session key passed in sessionKey of the visualize video request and the FRAME parameter indicates which 0-based frame of the video should be returned. All other WMS parameters are ignored for this mode.

For instance, if a 20 frame video with the session key 'MY-SESSION-KEY' was generated, the first frame could be retrieved with the URL:

http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=0

and the last frame could be retrieved with:

http://<hostname/ipAddress>:9191/wms?REQUEST=GetMap&STYLES=cached&LAYERS=MY-SESSION-KEY&FRAME=19

The response payload provides, among other things, the number of frames which were created.

Definition at line 459 of file visualize_video.h.

Constructor & Destructor Documentation

gpudb::VisualizeVideoResponse::VisualizeVideoResponse ( )

inline

Constructs a VisualizeVideoResponse object with default parameter values.

Definition at line 466 of file visualize_video.h.

Member Data Documentation

int64_t gpudb::VisualizeVideoResponse::bgColor

Definition at line 478 of file visualize_video.h.

std::vector<std::vector<uint8_t> > gpudb::VisualizeVideoResponse::data

Definition at line 481 of file visualize_video.h.

double gpudb::VisualizeVideoResponse::height

Definition at line 477 of file visualize_video.h.

int32_t gpudb::VisualizeVideoResponse::numFrames

Definition at line 479 of file visualize_video.h.

std::string gpudb::VisualizeVideoResponse::sessionKey

Definition at line 480 of file visualize_video.h.

double gpudb::VisualizeVideoResponse::width

Definition at line 476 of file visualize_video.h.

---

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

• gpudb/protocol/visualize_video.h