The DataInterface class represents an interface to a data source. More...

#include <DataInterface.h>

Public Types
enum	RenderTypes { RenderTypes::Unknown, RenderTypes::Evo, RenderTypes::Optera180, RenderTypes::Optera270, RenderTypes::Optera360, RenderTypes::Standard }
	Values that represent stream protocols. More...

enum	StreamFormats { StreamFormats::Unknown, StreamFormats::H264, StreamFormats::H265, StreamFormats::Mpeg4, StreamFormats::Jpeg, StreamFormats::G711 }
	Values that represent stream protocols. More...

enum	StreamProtocols { StreamProtocols::Unknown, StreamProtocols::MjpegPull, StreamProtocols::RtspRtp }
	Values that represent stream protocols. More...

Public Member Functions
	DataInterface (VxSdk::IVxDataInterface *vxDataInterface)
	Constructor. More...

Package Attributes
VxSdk::IVxDataInterface *	_dataInterface

Properties
int	Bitrate `[get]`
	Gets the average bitrate of the stream, if available (in kbps). More...

System::String^	DataEncodingId `[get]`
	Gets 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...

System::String^	DataEndpoint `[get]`
	Gets the endpoint of the data interface. More...

StreamFormats	Format `[get]`
	Gets the media stream encoding format. More...

float	Framerate `[get]`
	Gets the framerate of the data. More...

System::String^	MulticastTestIp `[get]`
	Gets the multicast test IP used to test transmission capabilities. More...

int	MulticastTestPort `[get]`
	Gets the multicast test port used to test transmission capabilities. More...

StreamProtocols	Protocol `[get]`
	Gets the protocol of the data interface. More...

RenderTypes	RenderType `[get]`
	Gets the type of rendering required for the media data delivered by this interface. More...

bool	SupportsMulticast `[get]`
	Gets a value indicating whether the interface supports multicast transmission. More...

int	XResolution `[get]`
	Gets the horizontal resolution of the data. More...

int	YResolution `[get]`
	Gets the vertical resolution of the data. More...

Detailed Description

The DataInterface class represents an interface to a data source.

Definition at line 12 of file DataInterface.h.

Member Enumeration Documentation

enum CPPCli::DataInterface::RenderTypes

strong

Values that represent stream protocols.

Enumerator
Unknown	An error or unknown value was returned.
Evo	Evo renderer.
Optera180	Optera 180 renderer.
Optera270	Optera 270 renderer.
Optera360	Optera 360 renderer.
Standard	Standard renderer.

Definition at line 18 of file DataInterface.h.

                                {
             Unknown,
 
             Evo,
 
             Optera180,
 
             Optera270,
 
             Optera360,
 
             Standard
         };

enum CPPCli::DataInterface::StreamFormats

strong

Values that represent stream protocols.

Enumerator
Unknown	An error or unknown value was returned.
H264	H.264 encoding format.
H265	H.265 encoding format.
Mpeg4	MPEG-4 encoding format.
Jpeg	JPEG encoding format.
G711	G.711 encoding format.

Definition at line 41 of file DataInterface.h.

enum CPPCli::DataInterface::StreamProtocols

strong

Values that represent stream protocols.

Enumerator
Unknown	An error or unknown value was returned.
MjpegPull	The Mjpeg (pull) protocol.
RtspRtp	The RTSP/RTP protocol.

Definition at line 64 of file DataInterface.h.

                                    {
             Unknown,
 
             MjpegPull,
 
             RtspRtp
         };

Constructor & Destructor Documentation

CPPCli::DataInterface::DataInterface ( VxSdk::IVxDataInterface * vxDataInterface )

Constructor.

Implements the data interface class.

Parameters

vxDataInterface The vx data interface.

Definition at line 6 of file DataInterface.cpp.

                                                                          {
     _dataInterface = vxDataInterface;
 }

Member Data Documentation

VxSdk::IVxDataInterface* CPPCli::DataInterface::_dataInterface

package

Definition at line 192 of file DataInterface.h.

Property Documentation

int CPPCli::DataInterface::Bitrate

get

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

The average bitrate of the stream.

Definition at line 85 of file DataInterface.h.

System:: String^ CPPCli::DataInterface::DataEncodingId

get

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

The data encoding unique identifier.

Definition at line 96 of file DataInterface.h.

System:: String^ CPPCli::DataInterface::DataEndpoint

get

Gets the endpoint of the data interface.

The data interface endpoint.

Definition at line 105 of file DataInterface.h.

StreamFormats CPPCli::DataInterface::Format

get

Gets the media stream encoding format.

The encoding format.

Definition at line 114 of file DataInterface.h.

float CPPCli::DataInterface::Framerate

get

Gets the framerate of the data.

The framerate.

Definition at line 123 of file DataInterface.h.

System:: String^ CPPCli::DataInterface::MulticastTestIp

get

Gets the multicast test IP used to test transmission capabilities.

The multicast test IP.

Definition at line 132 of file DataInterface.h.

int CPPCli::DataInterface::MulticastTestPort

get

Gets the multicast test port used to test transmission capabilities.

The multicast test port.

Definition at line 141 of file DataInterface.h.

StreamProtocols CPPCli::DataInterface::Protocol

get

Gets the protocol of the data interface.

The interface protocol.

Definition at line 150 of file DataInterface.h.

RenderTypes CPPCli::DataInterface::RenderType

get

Gets the type of rendering required for the media data delivered by this interface.

The rendering type.

Definition at line 159 of file DataInterface.h.

bool CPPCli::DataInterface::SupportsMulticast

get

Gets a value indicating whether the interface supports multicast transmission.

true if multicast is supported, false if not.

Definition at line 168 of file DataInterface.h.

int CPPCli::DataInterface::XResolution

get

Gets the horizontal resolution of the data.

The horizontal resolution.

Definition at line 177 of file DataInterface.h.

int CPPCli::DataInterface::YResolution

get

Gets the vertical resolution of the data.

The vertical resolution.

Definition at line 186 of file DataInterface.h.

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

C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/DataInterface.h
C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/DataInterface.cpp

Public Types

Public Member Functions

Package Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Data Documentation

Property Documentation