Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Loading...
Searching...
No Matches
rs2::software_sensor Class Reference

#include <rs_internal.hpp>

Inheritance diagram for rs2::software_sensor:
rs2::sensor rs2::options

Public Member Functions

stream_profile add_video_stream (rs2_video_stream video_stream, bool is_default=false)
stream_profile add_motion_stream (rs2_motion_stream motion_stream, bool is_default=false)
stream_profile add_pose_stream (rs2_pose_stream pose_stream, bool is_default=false)
void on_video_frame (rs2_software_video_frame frame)
void on_motion_frame (rs2_software_motion_frame frame)
void on_pose_frame (rs2_software_pose_frame frame)
void set_metadata (rs2_frame_metadata_value value, rs2_metadata_type type)
void add_read_only_option (rs2_option option, float val)
void set_read_only_option (rs2_option option, float val)
void add_option (rs2_option option, const option_range &range, bool is_writable=true)
void on_notification (rs2_software_notification notif)
void detach ()
Public Member Functions inherited from rs2::sensor
void open (const stream_profile &profile) const
bool supports (rs2_camera_info info) const
const char * get_info (rs2_camera_info info) const
void open (const std::vector< stream_profile > &profiles) const
void close () const
template<class T>
void start (T callback) const
void stop () const
template<class T>
void set_notifications_callback (T callback) const
std::vector< stream_profileget_stream_profiles () const
std::vector< stream_profileget_active_streams () const
std::vector< filterget_recommended_filters () const
sensoroperator= (const std::shared_ptr< rs2_sensor > other)
sensoroperator= (const sensor &other)
 sensor ()
 operator bool () const
const std::shared_ptr< rs2_sensor > & get () const
template<class T>
bool is () const
template<class T>
as () const
 sensor (std::shared_ptr< rs2_sensor > dev)
 operator std::shared_ptr< rs2_sensor > ()
bool supports (rs2_option option) const
Public Member Functions inherited from rs2::options
bool supports (rs2_option option) const
const char * get_option_description (rs2_option option) const
const char * get_option_name (rs2_option option) const
const char * get_option_value_description (rs2_option option, float val) const
float get_option (rs2_option option) const
option_value get_option_value (rs2_option option_id) const
option_range get_option_range (rs2_option option) const
void set_option (rs2_option option, float value) const
void set_option_value (option_value const &value) const
bool is_option_read_only (rs2_option option) const
void on_options_changed (std::function< void(const options_list &) > callback) const
std::vector< rs2_optionget_supported_options ()
options_list get_supported_option_values ()
optionsoperator= (const options &other)
 options (const options &other)
virtual ~options ()=default

Friends

class software_device

Additional Inherited Members

Protected Member Functions inherited from rs2::options
 options (rs2_options *o=nullptr)
template<class T>
optionsoperator= (const T &dev)
Protected Attributes inherited from rs2::sensor
friend context
friend device_list
friend device
friend device_base
friend roi_sensor
std::shared_ptr< rs2_sensor_sensor

Member Function Documentation

◆ add_motion_stream()

stream_profile rs2::software_sensor::add_motion_stream ( rs2_motion_stream motion_stream,
bool is_default = false )
inline

Add motion stream to software sensor

Parameters
[in]motionall the parameters that required to defind motion stream

◆ add_option()

void rs2::software_sensor::add_option ( rs2_option option,
const option_range & range,
bool is_writable = true )
inline

Register option that will be supported by the sensor

Parameters
[in]optionthe option
[in]rangerange data for the option. range.def will be used as the initial value

◆ add_pose_stream()

stream_profile rs2::software_sensor::add_pose_stream ( rs2_pose_stream pose_stream,
bool is_default = false )
inline

Add pose stream to software sensor

Parameters
[in]poseall the parameters that required to defind pose stream

◆ add_read_only_option()

void rs2::software_sensor::add_read_only_option ( rs2_option option,
float val )
inline

Register read-only option that will be supported by the sensor

Parameters
[in]optionthe option
[in]valthe initial value

◆ add_video_stream()

stream_profile rs2::software_sensor::add_video_stream ( rs2_video_stream video_stream,
bool is_default = false )
inline

Add video stream to software sensor

Parameters
[in]video_streamall the parameters that required to defind video stream

◆ detach()

void rs2::software_sensor::detach ( )
inline

Sensors hold the parent device in scope via a shared_ptr. This function detaches that so that the software sensor doesn't keep the software device alive. Note that this is dangerous as it opens the door to accessing freed memory if care isn't taken.

◆ on_motion_frame()

void rs2::software_sensor::on_motion_frame ( rs2_software_motion_frame frame)
inline

Inject motion frame into the sensor

Parameters
[in]frameall the parameters that required to define motion frame

◆ on_notification()

void rs2::software_sensor::on_notification ( rs2_software_notification notif)
inline

◆ on_pose_frame()

void rs2::software_sensor::on_pose_frame ( rs2_software_pose_frame frame)
inline

Inject pose frame into the sensor

Parameters
[in]frameall the parameters that required to define pose frame

◆ on_video_frame()

void rs2::software_sensor::on_video_frame ( rs2_software_video_frame frame)
inline

Inject video frame into the sensor

Parameters
[in]frameall the parameters that required to define video frame

◆ set_metadata()

void rs2::software_sensor::set_metadata ( rs2_frame_metadata_value value,
rs2_metadata_type type )
inline

Set frame metadata for the upcoming frames

Parameters
[in]valuemetadata key to set
[in]typemetadata value

◆ set_read_only_option()

void rs2::software_sensor::set_read_only_option ( rs2_option option,
float val )
inline

Update value of registered read-only option

Parameters
[in]optionthe option
[in]valthe initial value

◆ software_device

friend class software_device
friend

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