NVIDIA DeepStream SDK API Reference

9.2 Release
rs2::recorder Class Reference

Detailed Description

Inheritance diagram for rs2::recorder:
Collaboration diagram for rs2::recorder:

Public Member Functions

 recorder (device d)
 
 recorder (const std::string &file, rs2::device dev)
 Creates a recording device to record the given device and save it to the given file as rosbag format. More...
 
 recorder (const std::string &file, rs2::device dev, bool compression_enabled)
 Creates a recording device to record the given device and save it to the given file as rosbag format. More...
 
void pause ()
 Pause the recording device without stopping the actual device from streaming. More...
 
void resume ()
 Unpauses the recording device, making it resume recording. More...
 
std::string filename () const
 Gets the name of the file to which the recorder is writing. More...
 
 recorder (device d)
 
 recorder (const std::string &file, rs2::device dev)
 Creates a recording device to record the given device and save it to the given file as rosbag format. More...
 
 recorder (const std::string &file, rs2::device dev, bool compression_enabled)
 Creates a recording device to record the given device and save it to the given file as rosbag format. More...
 
void pause ()
 Pause the recording device without stopping the actual device from streaming. More...
 
void resume ()
 Unpauses the recording device, making it resume recording. More...
 
std::string filename () const
 Gets the name of the file to which the recorder is writing. More...
 
std::vector< sensor > query_sensors () const
 returns the list of adjacent devices, sharing the same physical parent composite device More...
 
std::vector< sensor > query_sensors () const
 returns the list of adjacent devices, sharing the same physical parent composite device More...
 
template<class T >
T first () const
 
template<class T >
T first () const
 
bool supports (rs2_camera_info info) const
 check if specific camera info is supported More...
 
bool supports (rs2_camera_info info) const
 check if specific camera info is supported More...
 
const char * get_info (rs2_camera_info info) const
 retrieve camera specific information, like versions of various internal components More...
 
const char * get_info (rs2_camera_info info) const
 retrieve camera specific information, like versions of various internal components More...
 
void hardware_reset ()
 send hardware reset request to the device More...
 
void hardware_reset ()
 send hardware reset request to the device More...
 
 operator bool () const
 
 operator bool () const
 
const std::shared_ptr< rs2_device > & get () const
 
const std::shared_ptr< rs2_device > & get () const
 
template<class T >
bool is () const
 
template<class T >
bool is () const
 
template<class T >
T as () const
 
template<class T >
T as () const
 
 operator std::shared_ptr< rs2_device > ()
 
 operator std::shared_ptr< rs2_device > ()
 

Protected Member Functions

 recorder (std::shared_ptr< rs2_device > dev)
 
 recorder (std::shared_ptr< rs2_device > dev)
 

Protected Attributes

std::shared_ptr< rs2_device > _dev
 

Constructor & Destructor Documentation

◆ recorder() [1/8]

rs2::recorder::recorder ( device  d)
inline

◆ recorder() [2/8]

rs2::recorder::recorder ( const std::string &  file,
rs2::device  dev 
)
inline

Creates a recording device to record the given device and save it to the given file as rosbag format.

Parameters
[in]fileThe desired path to which the recorder should save the data
[in]deviceThe device to record

Definition at line 213 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::device::get(), rs2::error::handle(), rs2_create_record_device(), and rs2_delete_device().

◆ recorder() [3/8]

rs2::recorder::recorder ( const std::string &  file,
rs2::device  dev,
bool  compression_enabled 
)
inline

Creates a recording device to record the given device and save it to the given file as rosbag format.

Parameters
[in]fileThe desired path to which the recorder should save the data
[in]deviceThe device to record
[in]compression_enabledIndicates if compression is enabled

Definition at line 228 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::device::get(), rs2::error::handle(), rs2_create_record_device_ex(), and rs2_delete_device().

◆ recorder() [4/8]

rs2::recorder::recorder ( std::shared_ptr< rs2_device >  dev)
inlineexplicitprotected

◆ recorder() [5/8]

rs2::recorder::recorder ( device  d)
inline

◆ recorder() [6/8]

rs2::recorder::recorder ( const std::string &  file,
rs2::device  dev 
)
inline

Creates a recording device to record the given device and save it to the given file as rosbag format.

Parameters
[in]fileThe desired path to which the recorder should save the data
[in]deviceThe device to record

Definition at line 213 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::device::get(), rs2::error::handle(), rs2_create_record_device(), and rs2_delete_device().

◆ recorder() [7/8]

rs2::recorder::recorder ( const std::string &  file,
rs2::device  dev,
bool  compression_enabled 
)
inline

Creates a recording device to record the given device and save it to the given file as rosbag format.

Parameters
[in]fileThe desired path to which the recorder should save the data
[in]deviceThe device to record
[in]compression_enabledIndicates if compression is enabled

Definition at line 228 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::device::get(), rs2::error::handle(), rs2_create_record_device_ex(), and rs2_delete_device().

◆ recorder() [8/8]

rs2::recorder::recorder ( std::shared_ptr< rs2_device >  dev)
inlineexplicitprotected

Member Function Documentation

◆ as() [1/2]

template<class T >
T rs2::device::as ( ) const
inlineinherited

◆ as() [2/2]

template<class T >
T rs2::device::as ( ) const
inlineinherited

◆ filename() [1/2]

std::string rs2::recorder::filename ( ) const
inline

Gets the name of the file to which the recorder is writing.

Returns
The name of the file to which the recorder is writing

Definition at line 262 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_record_device_filename().

Referenced by filename().

◆ filename() [2/2]

std::string rs2::recorder::filename ( ) const
inline

Gets the name of the file to which the recorder is writing.

Returns
The name of the file to which the recorder is writing

Definition at line 262 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, filename(), rs2::error::handle(), and rs2_record_device_filename().

◆ first() [1/2]

template<class T >
T rs2::device::first ( ) const
inlineinherited

◆ first() [2/2]

template<class T >
T rs2::device::first ( ) const
inlineinherited

◆ get() [1/2]

◆ get() [2/2]

const std::shared_ptr<rs2_device>& rs2::device::get ( ) const
inlineinherited

◆ get_info() [1/2]

const char* rs2::device::get_info ( rs2_camera_info  info) const
inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters
[in]infocamera info type to retrieve
Returns
the requested camera info string, in a format specific to the device model

Definition at line 79 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_get_device_info().

◆ get_info() [2/2]

const char* rs2::device::get_info ( rs2_camera_info  info) const
inlineinherited

retrieve camera specific information, like versions of various internal components

Parameters
[in]infocamera info type to retrieve
Returns
the requested camera info string, in a format specific to the device model

Definition at line 79 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_get_device_info().

◆ hardware_reset() [1/2]

void rs2::device::hardware_reset ( )
inlineinherited

send hardware reset request to the device

Definition at line 90 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_hardware_reset().

◆ hardware_reset() [2/2]

void rs2::device::hardware_reset ( )
inlineinherited

send hardware reset request to the device

Definition at line 90 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_hardware_reset().

◆ is() [1/2]

template<class T >
bool rs2::device::is ( ) const
inlineinherited

◆ is() [2/2]

template<class T >
bool rs2::device::is ( ) const
inlineinherited

◆ operator bool() [1/2]

rs2::device::operator bool ( ) const
inlineinherited

◆ operator bool() [2/2]

rs2::device::operator bool ( ) const
inlineinherited

◆ operator std::shared_ptr< rs2_device >() [1/2]

rs2::device::operator std::shared_ptr< rs2_device > ( )
inlineexplicitinherited

◆ operator std::shared_ptr< rs2_device >() [2/2]

rs2::device::operator std::shared_ptr< rs2_device > ( )
inlineexplicitinherited

◆ pause() [1/2]

void rs2::recorder::pause ( )
inline

Pause the recording device without stopping the actual device from streaming.

Definition at line 241 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_record_device_pause().

◆ pause() [2/2]

void rs2::recorder::pause ( )
inline

Pause the recording device without stopping the actual device from streaming.

Definition at line 241 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_record_device_pause().

◆ query_sensors() [1/2]

std::vector<sensor> rs2::device::query_sensors ( ) const
inlineinherited

returns the list of adjacent devices, sharing the same physical parent composite device

Returns
the list of adjacent devices

Definition at line 25 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), rs2_create_sensor(), rs2_delete_sensor(), rs2_delete_sensor_list(), rs2_get_sensors_count(), rs2_query_sensors(), and pydeepstreamdoc::tensor::TensorDoc::size.

Referenced by rs2::device::first().

◆ query_sensors() [2/2]

std::vector<sensor> rs2::device::query_sensors ( ) const
inlineinherited

returns the list of adjacent devices, sharing the same physical parent composite device

Returns
the list of adjacent devices

Definition at line 25 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), rs2_create_sensor(), rs2_delete_sensor(), rs2_delete_sensor_list(), rs2_get_sensors_count(), rs2_query_sensors(), and pydeepstreamdoc::tensor::TensorDoc::size.

◆ resume() [1/2]

void rs2::recorder::resume ( )
inline

Unpauses the recording device, making it resume recording.

Definition at line 251 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_record_device_resume().

◆ resume() [2/2]

void rs2::recorder::resume ( )
inline

Unpauses the recording device, making it resume recording.

Definition at line 251 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_record_playback.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_record_device_resume().

◆ supports() [1/2]

bool rs2::device::supports ( rs2_camera_info  info) const
inlineinherited

check if specific camera info is supported

Parameters
[in]infothe parameter to check for support
Returns
true if the parameter both exist and well-defined for the specific device

Definition at line 66 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_supports_device_info().

◆ supports() [2/2]

bool rs2::device::supports ( rs2_camera_info  info) const
inlineinherited

check if specific camera info is supported

Parameters
[in]infothe parameter to check for support
Returns
true if the parameter both exist and well-defined for the specific device

Definition at line 66 of file 9.2/sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

References rs2::device::_dev, rs2::error::handle(), and rs2_supports_device_info().

Field Documentation

◆ _dev

std::shared_ptr< rs2_device > rs2::device::_dev
protectedinherited

Definition at line 146 of file sources/libs/ds3d/3rdparty/realsense2/include/librealsense2/hpp/rs_device.hpp.

Referenced by rs2::software_device::add_sensor(), rs2::software_device::add_to(), rs400::advanced_mode::advanced_mode(), rs2::auto_calibrated_device::auto_calibrated_device(), rs2::calibration_change_device::calibration_change_device(), rs2::updatable::check_firmware_compatibility(), rs2::tm2::connect_controller(), rs2::updatable::create_flash_backup(), rs2::software_device::create_matcher(), rs2::firmware_logger::create_message(), rs2::firmware_logger::create_parsed_message(), rs2::playback::current_status(), rs2::debug_protocol::debug_protocol(), rs2::device_calibration::device_calibration(), rs2::tm2::disable_loopback(), rs2::tm2::disconnect_controller(), rs2::tm2::enable_loopback(), rs2::updatable::enter_update_state(), filename(), rs2::firmware_logger::firmware_logger(), rs2::device::get(), rs400::advanced_mode::get_ae_control(), rs400::advanced_mode::get_amp_factor(), rs2::auto_calibrated_device::get_calibration_table(), rs400::advanced_mode::get_census(), rs400::advanced_mode::get_color_control(), rs400::advanced_mode::get_color_correction(), rs400::advanced_mode::get_depth_control(), rs400::advanced_mode::get_depth_table(), rs2::playback::get_duration(), rs2::firmware_logger::get_firmware_log(), rs2::firmware_logger::get_flash_log(), rs400::advanced_mode::get_hdad(), rs2::device::get_info(), rs2::firmware_logger::get_number_of_fw_logs(), rs2::playback::get_position(), rs400::advanced_mode::get_rau_support_vector_control(), rs400::advanced_mode::get_rau_thresholds_control(), rs400::advanced_mode::get_rsm(), rs400::advanced_mode::get_slo_color_thresholds_control(), rs400::advanced_mode::get_slo_penalty_control(), rs2::device::hardware_reset(), rs2::firmware_logger::init_parser(), rs2::device_hub::is_connected(), rs400::advanced_mode::is_enabled(), rs2::tm2::is_loopback_enabled(), rs2::playback::is_real_time(), rs2::serializable_device::load_json(), rs2::device::operator bool(), rs2::device::operator std::shared_ptr< rs2_device >(), rs2::device::operator=(), rs2::firmware_logger::parse_log(), rs2::playback::pause(), pause(), rs2::playback::playback(), rs2::device::query_sensors(), recorder(), rs2::calibration_change_device::register_calibration_change_callback(), rs2::software_device::register_info(), rs2::calibrated_device::reset_to_factory_calibration(), rs2::playback::resume(), resume(), rs2::auto_calibrated_device::run_on_chip_calibration(), rs2::auto_calibrated_device::run_tare_calibration(), rs2::playback::seek(), rs2::debug_protocol::send_and_receive_raw_data(), rs2::serializable_device::serializable_device(), rs2::serializable_device::serialize_json(), rs400::advanced_mode::set_ae_control(), rs400::advanced_mode::set_amp_factor(), rs2::auto_calibrated_device::set_calibration_table(), rs400::advanced_mode::set_census(), rs400::advanced_mode::set_color_control(), rs400::advanced_mode::set_color_correction(), rs400::advanced_mode::set_depth_control(), rs400::advanced_mode::set_depth_table(), rs2::software_device::set_destruction_callback(), rs400::advanced_mode::set_hdad(), rs2::playback::set_playback_speed(), rs400::advanced_mode::set_rau_support_vector_control(), rs400::advanced_mode::set_rau_thresholds_control(), rs2::playback::set_real_time(), rs400::advanced_mode::set_rsm(), rs400::advanced_mode::set_slo_color_thresholds_control(), rs400::advanced_mode::set_slo_penalty_control(), rs2::playback::set_status_changed_callback(), rs2::playback::stop(), rs2::device::supports(), rs2::tm2::tm2(), rs400::advanced_mode::toggle_advanced_mode(), rs2::device_calibration::trigger_device_calibration(), rs2::updatable::updatable(), rs2::update_device::update(), rs2::update_device::update_device(), rs2::software_device::update_info(), rs2::updatable::update_unsigned(), and rs2::calibrated_device::write_calibration().


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