LibMultiSense
LibMultiSense Documentation
crl::multisense::DirectedStream Class Reference

Class used to request that MultiSense data be sent to a 3rd-party stream destination (UDP port), currently supported only by CRL's Monocular IP Camera. More...

#include <MultiSenseTypes.hh>

Public Member Functions

 DirectedStream ()
 Default constructor. More...
 
 DirectedStream (DataSource m, const std::string &addr, uint16_t p=DFL_UDP_PORT, uint32_t dec=1)
 Constructor to initialize a directed stream between a MultiSense device and a host machine. More...
 

Public Attributes

DataSource mask
 The data source to stream to a given device. More...
 
std::string address
 IPv4 Address dotted quad. More...
 
uint16_t udpPort
 default=10001 More...
 
uint32_t fpsDecimation
 Every Nth image to send. More...
 

Static Public Attributes

static CRL_CONSTEXPR uint16_t DFL_UDP_PORT = 10001
 Default UDP target port. More...
 

Detailed Description

Class used to request that MultiSense data be sent to a 3rd-party stream destination (UDP port), currently supported only by CRL's Monocular IP Camera.

This functionality is not supported by any of CRL's stereo sensor products.

Definition at line 205 of file MultiSenseTypes.hh.

Constructor & Destructor Documentation

◆ DirectedStream() [1/2]

crl::multisense::DirectedStream::DirectedStream ( )
inline

Default constructor.

Definition at line 223 of file MultiSenseTypes.hh.

◆ DirectedStream() [2/2]

crl::multisense::DirectedStream::DirectedStream ( DataSource  m,
const std::string &  addr,
uint16_t  p = DFL_UDP_PORT,
uint32_t  dec = 1 
)
inline

Constructor to initialize a directed stream between a MultiSense device and a host machine.

Parameters
mThe data Sources to stream to a give device
addrA IP address to send steam data to
pThe UDP port to send stream data data to
decThe number of frames to decimate (i.e. if image.frameID % dec == 0 send the image stream)

Definition at line 237 of file MultiSenseTypes.hh.

Member Data Documentation

◆ address

std::string crl::multisense::DirectedStream::address

IPv4 Address dotted quad.

Definition at line 214 of file MultiSenseTypes.hh.

◆ DFL_UDP_PORT

CRL_CONSTEXPR uint16_t crl::multisense::DirectedStream::DFL_UDP_PORT = 10001
static

Default UDP target port.

Definition at line 209 of file MultiSenseTypes.hh.

◆ fpsDecimation

uint32_t crl::multisense::DirectedStream::fpsDecimation

Every Nth image to send.

For a value of 1 every image is sent

Definition at line 218 of file MultiSenseTypes.hh.

◆ mask

DataSource crl::multisense::DirectedStream::mask

The data source to stream to a given device.

Definition at line 212 of file MultiSenseTypes.hh.

◆ udpPort

uint16_t crl::multisense::DirectedStream::udpPort

default=10001

Definition at line 216 of file MultiSenseTypes.hh.


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