Represents a data interface for a data source. Clients can retrieve data from the data source using the protocol specified by this interface. More...

#include <IVxDataInterface.h>

Public Attributes
bool	supportsMulticast
	Indicates whether the interface provides multicast transmission. More...

char	dataEncodingId [64]
	The unique identifier for a specific data encoding (based on encoding quality, framerate, and resolution). Multiple identical copies of the data may exist across the system; these will have the same dataEncodingId. This ID may be used when requesting a specific encoding to export, record, playback, etc. More...

char	dataEndpoint [512]
	The protocol-specific stream control endpoint URI. More...

char	multicastTestIp [64]
	The multicast test IP used to test transmission capabilities. More...

float	framerate
	The framerate of the data. More...

int	bitrate
	Average bitrate of the stream, if available (in kbps). More...

int	xResolution
	Horizontal resolution of the data. More...

int	yResolution
	Vertical resolution of the data. More...

unsigned short	multicastTestPort
	The multicast test port used to test transmission capabilities. More...

VxRenderType::Value	renderType
	The type of rendering required for the media data delivered by this interface. Clients can utilize this to create the correct rendering pipeline. Defaults to standard. More...

VxStreamFormat::Value	format
	The media stream encoding format. More...

VxStreamProtocol::Value	protocol
	The transport protocol used by the data interface. More...

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

Detailed Description

Represents a data interface for a data source. Clients can retrieve data from the data source using the protocol specified by this interface.

Definition at line 13 of file IVxDataInterface.h.

Member Function Documentation

void VxSdk::IVxDataInterface::Clear ( )

inlineprotected

Clears this instance.

Definition at line 71 of file IVxDataInterface.h.

                      {
             this->supportsMulticast = false;
             VxZeroArray(this->dataEncodingId);
             VxZeroArray(this->dataEndpoint);
             VxZeroArray(this->multicastTestIp);
             this->framerate = 0.0f;
             this->bitrate = 0;
             this->xResolution = 0;
             this->yResolution = 0;
             this->multicastTestPort = 0;
             this->renderType = VxRenderType::kUnknown;
             this->format = VxStreamFormat::kUnknown;
             this->protocol = VxStreamProtocol::kUnknown;
         }

Member Data Documentation

int VxSdk::IVxDataInterface::bitrate

Average bitrate of the stream, if available (in kbps).

Definition at line 40 of file IVxDataInterface.h.

char VxSdk::IVxDataInterface::dataEncodingId[64]

The unique identifier for a specific data encoding (based on encoding quality, framerate, and resolution). Multiple identical copies of the data may exist across the system; these will have the same dataEncodingId. This ID may be used when requesting a specific encoding to export, record, playback, etc.

Definition at line 24 of file IVxDataInterface.h.

char VxSdk::IVxDataInterface::dataEndpoint[512]

The protocol-specific stream control endpoint URI.

Definition at line 28 of file IVxDataInterface.h.

VxStreamFormat::Value VxSdk::IVxDataInterface::format

The media stream encoding format.

Definition at line 61 of file IVxDataInterface.h.

float VxSdk::IVxDataInterface::framerate

The framerate of the data.

Definition at line 36 of file IVxDataInterface.h.

char VxSdk::IVxDataInterface::multicastTestIp[64]

The multicast test IP used to test transmission capabilities.

Definition at line 32 of file IVxDataInterface.h.

unsigned short VxSdk::IVxDataInterface::multicastTestPort

The multicast test port used to test transmission capabilities.

Definition at line 52 of file IVxDataInterface.h.

VxStreamProtocol::Value VxSdk::IVxDataInterface::protocol

The transport protocol used by the data interface.

Definition at line 65 of file IVxDataInterface.h.

VxRenderType::Value VxSdk::IVxDataInterface::renderType

The type of rendering required for the media data delivered by this interface. Clients can utilize this to create the correct rendering pipeline. Defaults to standard.

Definition at line 57 of file IVxDataInterface.h.

bool VxSdk::IVxDataInterface::supportsMulticast

Indicates whether the interface provides multicast transmission.

Definition at line 18 of file IVxDataInterface.h.

int VxSdk::IVxDataInterface::xResolution

Horizontal resolution of the data.

Definition at line 44 of file IVxDataInterface.h.

int VxSdk::IVxDataInterface::yResolution

Vertical resolution of the data.

Definition at line 48 of file IVxDataInterface.h.

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

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

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation