Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.ShowVideoRequest Class Reference

A set of parameters for Kinetica.showVideo(IList{string},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.ShowVideoRequest:
+ Collaboration diagram for kinetica.ShowVideoRequest:

Public Member Functions

 ShowVideoRequest ()
 Constructs a ShowVideoRequest object with default parameters. More...
 
 ShowVideoRequest (IList< string > paths, IDictionary< string, string > options=null)
 Constructs a ShowVideoRequest 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...
 

Properties

IList< string > paths [get, set]
 The fully-qualified KiFS paths for the videos to show. More...
 
IDictionary< string, string > options = new List<string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

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

Detailed Description

A set of parameters for Kinetica.showVideo(IList{string},IDictionary{string, string}).


Retrieves information about rendered videos.

Definition at line 19 of file ShowVideo.cs.

Constructor & Destructor Documentation

kinetica.ShowVideoRequest.ShowVideoRequest ( )
inline

Constructs a ShowVideoRequest object with default parameters.

Definition at line 34 of file ShowVideo.cs.

kinetica.ShowVideoRequest.ShowVideoRequest ( IList< string >  paths,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowVideoRequest object with the specified parameters.

Parameters
pathsThe fully-qualified KiFS paths for the videos to show. If empty, shows all videos.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 45 of file ShowVideo.cs.

Property Documentation

IDictionary<string, string> kinetica.ShowVideoRequest.options = new List<string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 29 of file ShowVideo.cs.

IList<string> kinetica.ShowVideoRequest.paths
getset

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

If empty, shows all videos.

Definition at line 25 of file ShowVideo.cs.


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