Represents a data session that is being transmitted by a data source, via a data interface, to a client. More...

#include <IVxDataSession.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...

virtual VxResult::Value	DeleteDataSession ()=0
	Terminates the current data session. More...

virtual VxResult::Value	GetAuthToken (char *token, int &size) const =0
	Gets the data session authentication token. More...

virtual VxResult::Value	GetDataSource (IVxDataSource *&dataSource) const =0
	Gets the IVxDataSource from which this session is retrieving data. More...

virtual VxResult::Value	GetUser (IVxUser *&user) const =0
	Gets the IVxUser that this session is being used by, if any. More...

virtual VxResult::Value	GoLive ()=0
	Sets the position of the data session as close to live as possible. More...

virtual VxResult::Value	Pause ()=0
	Pauses the data session. More...

virtual VxResult::Value	Play ()=0
	Starts or resumes the data session. More...

virtual VxResult::Value	Seek (long long unixTime, float speed)=0
	Seeks to the frame nearest to the given time. More...

virtual VxResult::Value	SetSpeed (float speed)=0
	Sets the play speed of the data session. Negative values indicate reverse speeds while positive values indicate forward speeds (1 is normal speed). More...

virtual VxResult::Value	SetQuality (unsigned short quality)=0
	Sets the quality property. More...

virtual VxResult::Value	SetResolution (unsigned short xResolution, unsigned short yResolution)=0
	Sets the resolution properties. More...

virtual VxResult::Value	Update ()=0
	Updates the values of this instance. More...

Public Attributes
char	id [64]
	The unique identifier of the data session. More...

char	jpegUri [512]
	The URI of the JPEG frame. More...

float	speed
	The play speed of the data. More...

unsigned short	quality
	The image quality of the data from 1 to 100. Smaller numbers have better quality than larger numbers. More...

unsigned short	xResolution
	The horizontal resolution of the data (Width). More...

unsigned short	yResolution
	The vertical resolution of the data (Height). More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a data session that is being transmitted by a data source, via a data interface, to a client.

Definition at line 15 of file IVxDataSession.h.

Member Function Documentation

void VxSdk::IVxDataSession::Clear ( )

inlineprotected

Clears this instance.

Definition at line 124 of file IVxDataSession.h.

                      {
             VxZeroArray(this->id);
             VxZeroArray(this->jpegUri);
             this->speed = 0;
             this->quality = 0;
             this->xResolution = 0;
             this->yResolution = 0;
         }

virtual VxResult::Value VxSdk::IVxDataSession::Delete ( ) const

pure virtual

Deletes this instance.

Returns: The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxDataSession::DeleteDataSession ( )

pure virtual

Terminates the current data session.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::GetAuthToken	(	char *	token,
		int &	size
	)		const

pure virtual

Gets the data session authentication token.

Parameters

token	The authentication token.
size	The size of token .

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::GetDataSource ( IVxDataSource *& dataSource ) const

pure virtual

Gets the IVxDataSource from which this session is retrieving data.

Parameters

dataSource The IVxDataSource for this session.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::GetUser ( IVxUser *& user ) const

pure virtual

Gets the IVxUser that this session is being used by, if any.

Parameters

user	The IVxUser using this session.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::GoLive ( )

pure virtual

Sets the position of the data session as close to live as possible.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::Pause ( )

pure virtual

Pauses the data session.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::Play ( )

pure virtual

Starts or resumes the data session.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::Seek	(	long long	unixTime,
		float	speed
	)

pure virtual

Seeks to the frame nearest to the given time.

Parameters

unixTime	The seek time in unix time format.
speed	The playback speed.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::SetQuality ( unsigned short quality )

pure virtual

Sets the quality property.

Parameters

quality The new quality value.

Returns: The Result of setting the property.

virtual VxResult::Value VxSdk::IVxDataSession::SetResolution	(	unsigned short	xResolution,
		unsigned short	yResolution
	)

pure virtual

Sets the resolution properties.

Parameters

xResolution	The new horizontal resolution value.
yResolution	The new vertical resolution value.

Returns: The Result of setting the properties.

virtual VxResult::Value VxSdk::IVxDataSession::SetSpeed ( float speed )

pure virtual

Sets the play speed of the data session. Negative values indicate reverse speeds while positive values indicate forward speeds (1 is normal speed).

Parameters

speed The playback speed.

Returns: The Result of the request.

virtual VxResult::Value VxSdk::IVxDataSession::Update ( )

pure virtual

Updates the values of this instance.

Returns: The Result of updating this instance.

Member Data Documentation

char VxSdk::IVxDataSession::id[64]

The unique identifier of the data session.

Definition at line 98 of file IVxDataSession.h.

char VxSdk::IVxDataSession::jpegUri[512]

The URI of the JPEG frame.

Definition at line 102 of file IVxDataSession.h.

unsigned short VxSdk::IVxDataSession::quality

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

Definition at line 110 of file IVxDataSession.h.

float VxSdk::IVxDataSession::speed

The play speed of the data.

Definition at line 106 of file IVxDataSession.h.

unsigned short VxSdk::IVxDataSession::xResolution

The horizontal resolution of the data (Width).

Definition at line 114 of file IVxDataSession.h.

unsigned short VxSdk::IVxDataSession::yResolution

The vertical resolution of the data (Height).

Definition at line 118 of file IVxDataSession.h.

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

C:/Git/VXSDK_M3/VxSdk/Include/IVxDataSession.h

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation