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, const CAMERA_TYPE camera_type=CAMERA_TYPE::STEREO)
	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 sender_ip, 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 () const
	Returns the current input type. More...
sl::String	getConfiguration () const
	Returns the current input configuration as a string e.g: SVO name, serial number, streaming ip, etc. More...
bool	isInit () const
	Check whether the input is set. More...
bool	save (String filename) const
	Saves the current set of parameters into a file to be reloaded with the load() method. More...
bool	load (String filename)
	Loads a set of parameters from the values contained in a previously saved file. More...
bool	encode (String &serialized_content) const
	Generate a JSON Object (with the struct type as a key) containing the serialized struct, converted into a string. More...
bool	decode (const String &serialized_content)
	Fill the structure from the serialized json object contained in the input string. More...
bool	operator== (const InputType &param1) const
	Comparison operator ==. More...
bool	operator!= (const InputType &param1) const
	Comparison operator !=. 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,
		const CAMERA_TYPE	camera_type = CAMERA_TYPE::STEREO
	)

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.
camera_type	: Type of the camera (stereo or mono).

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	sender_ip,
		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 ( ) const

inline

Returns the current input type.

getConfiguration()

sl::String getConfiguration ( ) const

inline

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

isInit()

bool isInit ( ) const

inline

Check whether the input is set.

save()

bool save

(

String

filename

)

const

Saves the current set of parameters into a file to be reloaded with the load() method.

Parameters

filename

: Name of the file which will be created to store the parameters (extension '.yml' will be added if not set).

Returns

True if file was successfully saved, otherwise false.

Warning

For security reason, the file must not exist.

In case a file already exists, the method will return false and existing file will not be updated.

load()

bool load

(

String

filename

)

Loads a set of parameters from the values contained in a previously saved file.

Parameters

filename

: Path to the file from which the parameters will be loaded (extension '.yml' will be added at the end of the filename if not set).

Returns

True if the file was successfully loaded, otherwise false.

InitParameters init_params; // Set initial parameters
init_params.load("initParameters.yml"); // Load the init_params from a previously exported file

Note

As the InitParameters files can be easily modified manually (using a text editor) this function allows you to test various settings without re-compiling your application.

encode()

bool encode

(

String &

serialized_content

)

const

Generate a JSON Object (with the struct type as a key) containing the serialized struct, converted into a string.

Parameters

serialized_content

output string containing the JSON Object

Returns

True if file was successfully saved, otherwise false.

decode()

bool decode

(

const String &

serialized_content

)

Fill the structure from the serialized json object contained in the input string.

Parameters

serialized_content

input string containing the JSON Object

Returns

True if the decoding was successful, otherwise false.

operator==()

bool operator==

(

const InputType &

param1

)

const

Comparison operator ==.

Parameters

param1

to compare

Returns

true if the two struct are identical

operator!=()

bool operator!=

(

const InputType &

param1

)

const

Comparison operator !=.

Parameters

param1

to compare

Returns

true if the two struct are different