InputType Class Reference

Class defining the input type used in the ZED SDK. More...

Types

enum class  INPUT_TYPE
 Lists input types in the ZED SDK. More...
 

Functions

 InputType ()
 Default constructor. More...
 
 InputType (const InputType &type)
 Copy constructor. More...
 
void setFromCameraID (int id=-1, sl::BUS_TYPE bus_type=sl::BUS_TYPE::AUTO)
 Set the input as the camera with specified id (for USB or GMSL cameras only). More...
 
void setFromSerialNumber (unsigned int camera_serial_number, sl::BUS_TYPE bus_type=sl::BUS_TYPE::AUTO)
 Set the input as the camera with specified serial number (for USB or GMSL cameras). More...
 
void setFromSVOFile (sl::String svo_input_filename)
 Set the input as the SVO specified with the filename. More...
 
void setFromStream (sl::String senderIP, unsigned short port=30000)
 Set the input as the stream defined by the IP address and the port of the sending device. More...
 
INPUT_TYPE getType ()
 Returns the current input type. More...
 
sl::String getConfiguration ()
 Returns the current input configuration as a string e.g: SVO name, serial number, streaming ip, etc. More...
 
bool isInit ()
 Check whether the input is set. More...
 

Detailed Description

Class defining the input type used in the ZED SDK.

It can be used to select a specific camera with an id or serial number, or from a SVO file.

Enumeration

◆ INPUT_TYPE

enum INPUT_TYPE
strong

Lists input types in the ZED SDK.

Enumerator
USB_ID 

USB input from an id

USB_SERIAL 

USB input from a serial number

SVO_FILE 

SVO file input

STREAM 

STREAM input (requires to use enableStreaming() / disableStreaming()" on the "sender" side)

GMSL_ID 

GMSL input from an id (only on NVIDIA Jetson)

GMSL_SERIAL 

GMSL input from a serial number (only on NVIDIA Jetson)

Constructor and Destructor

◆ InputType() [1/2]

InputType ( )

Default constructor.

◆ InputType() [2/2]

InputType ( const InputType type)

Copy constructor.

Functions

◆ setFromCameraID()

void setFromCameraID ( int  id = -1,
sl::BUS_TYPE  bus_type = sl::BUS_TYPE::AUTO 
)

Set the input as the camera with specified id (for USB or GMSL cameras only).

Parameters
id: Id of the camera to open.
bus_type: Whether the camera is a USB or a GMSL camera.

◆ setFromSerialNumber()

void setFromSerialNumber ( unsigned int  camera_serial_number,
sl::BUS_TYPE  bus_type = sl::BUS_TYPE::AUTO 
)

Set the input as the camera with specified serial number (for USB or GMSL cameras).

Parameters
camera_serial_number: Serial number of the camera to open.
bus_type: Whether the camera is a USB or a GMSL camera.

◆ setFromSVOFile()

void setFromSVOFile ( sl::String  svo_input_filename)

Set the input as the SVO specified with the filename.

Parameters
svo_input_filename: Path of the SVO file to open.

◆ setFromStream()

void setFromStream ( sl::String  senderIP,
unsigned short  port = 30000 
)

Set the input as the stream defined by the IP address and the port of the sending device.

Parameters
sender_ip: IP address of the streaming sender.
port: Port on which to listen. Default: 30000
Note
The protocol used for the streaming module is based on RTP/RTCP.
Warning
Port must be even number, since the port+1 is used for control data.

◆ getType()

INPUT_TYPE getType ( )
inline

Returns the current input type.

◆ getConfiguration()

sl::String getConfiguration ( )
inline

Returns the current input configuration as a string e.g: SVO name, serial number, streaming ip, etc.

◆ isInit()

bool isInit ( )
inline

Check whether the input is set.