GPUdb C++ API  Version 7.2.2.4
gpudb::ShowVideoRequest Struct Reference

A set of parameters for GPUdb::showVideo. More...

#include <gpudb/protocol/show_video.h>

Public Member Functions

 ShowVideoRequest ()
 Constructs a ShowVideoRequest object with default parameters. More...
 
 ShowVideoRequest (const std::vector< std::string > &paths_, const std::map< std::string, std::string > &options_)
 Constructs a ShowVideoRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > paths
 The fully-qualified KiFS paths for the videos to show. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showVideo.

Retrieves information about rendered videos.

Definition at line 17 of file show_video.h.

Constructor & Destructor Documentation

◆ ShowVideoRequest() [1/2]

gpudb::ShowVideoRequest::ShowVideoRequest ( )
inline

Constructs a ShowVideoRequest object with default parameters.

Definition at line 22 of file show_video.h.

◆ ShowVideoRequest() [2/2]

gpudb::ShowVideoRequest::ShowVideoRequest ( const std::vector< std::string > &  paths_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowVideoRequest object with the specified parameters.

Parameters
[in]paths_The fully-qualified KiFS paths for the videos to show. If empty, shows all videos.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 38 of file show_video.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::ShowVideoRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 54 of file show_video.h.

◆ paths

std::vector<std::string> gpudb::ShowVideoRequest::paths

The fully-qualified KiFS paths for the videos to show.

If empty, shows all videos.

Definition at line 49 of file show_video.h.


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