The DataSession class represents a data session that is being transmitted by a data source, via a data interface, to a client. More...

#include <DataSession.h>

Public Member Functions
	DataSession (VxSdk::IVxDataSession *vxDataSession)
	Constructor. More...

virtual	~DataSession ()
	Destructor. More...

	!DataSession ()
	Finaliser. More...

Results::Value	Update ()
	Refreshes this instances properties. More...

Package Attributes
VxSdk::IVxDataSession *	_dataSession

Properties
int	Height `[get]`
	Gets the vertical resolution of the data (Height). More...

System::String^	Id `[get]`
	Gets the unique identifier of the sessions data source. More...

System::String^	JpegUri `[get]`
	Gets URI of the JPEG frame. More...

int	Quality `[get]`
	Gets the image quality of the data from 1 to 100. Smaller numbers have better quality than larger numbers. More...

float	Speed `[get]`
	Gets the play speed of the data. More...

int	Width `[get]`
	Gets the horizontal resolution of the data (Width). More...

Detailed Description

The DataSession class represents a data session that is being transmitted by a data source, via a data interface, to a client.

Definition at line 13 of file DataSession.h.

Constructor & Destructor Documentation

CPPCli::DataSession::DataSession ( VxSdk::IVxDataSession * vxDataSession )

inline

Constructor.

Parameters

vxDataSession The vx data session.

Definition at line 20 of file DataSession.h.

                                                         {
             _dataSession = vxDataSession;
         }

virtual CPPCli::DataSession::~DataSession ( )

inlinevirtual

Destructor.

Definition at line 27 of file DataSession.h.

                                {
             this->!DataSession();
         }

CPPCli::DataSession::!DataSession ( )

inline

Finaliser.

Definition at line 34 of file DataSession.h.

                        {
             _dataSession->Delete();
             _dataSession = nullptr;
         }

Member Function Documentation

Results::Value CPPCli::DataSession::Update ( )

inline

Refreshes this instances properties.

Returns: The Result of updating the properties.

Definition at line 43 of file DataSession.h.

43 { return (CPPCli::Results::Value)_dataSession->Update(); }

CPPCli::Results::Value

Value

Values that represent the result of calls to the VideoXpert system.

Definition: Utils.h:21

VxSdk::IVxDataSession::Update

virtual VxResult::Value Update()=0

CPPCli::DataSession::_dataSession

VxSdk::IVxDataSession * _dataSession

Definition: DataSession.h:100

Member Data Documentation

VxSdk::IVxDataSession* CPPCli::DataSession::_dataSession

package

Definition at line 100 of file DataSession.h.

Property Documentation

int CPPCli::DataSession::Height

get

Gets the vertical resolution of the data (Height).

The vertical resolution.

Definition at line 49 of file DataSession.h.

System:: String^ CPPCli::DataSession::Id

get

Gets the unique identifier of the sessions data source.

The unique identifier.

Definition at line 58 of file DataSession.h.

System:: String^ CPPCli::DataSession::JpegUri

get

Gets URI of the JPEG frame.

The JPEG URI.

Definition at line 67 of file DataSession.h.

int CPPCli::DataSession::Quality

get

Gets the image quality of the data from 1 to 100. Smaller numbers have better quality than larger numbers.

The image quality value.

Definition at line 76 of file DataSession.h.

float CPPCli::DataSession::Speed

get

Gets the play speed of the data.

The play speed.

Definition at line 85 of file DataSession.h.

int CPPCli::DataSession::Width

get

Gets the horizontal resolution of the data (Width).

The horizontal resolution.

Definition at line 94 of file DataSession.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/DataSession.h

Public Member Functions

Package Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation