Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Classes | Typedefs | Enumerations | Functions | Variables
librealsense::platform Namespace Reference

Classes

class  auto_reset_event
 
class  backend
 
struct  backend_device_group
 
class  buffer
 
struct  call
 
struct  callback_data
 
class  command_transfer
 
class  compression_algorithm
 
struct  control_range
 
class  device_watcher
 
class  event_base
 
struct  extension_unit
 
struct  frame_object
 
struct  guid
 
class  hid_custom_sensor
 
class  hid_device
 
struct  hid_device_info
 
class  hid_input
 
struct  hid_input_info
 
struct  hid_profile
 
struct  hid_sensor
 
struct  hid_sensor_data
 
struct  hid_sensor_input
 
class  iio_hid_sensor
 
struct  lookup_key
 
class  manual_reset_event
 
class  multi_pins_hid_device
 
class  multi_pins_uvc_device
 
class  named_mutex
 
class  os_time_service
 
class  playback_backend
 
struct  playback_device_info
 
class  playback_device_watcher
 
class  playback_hid_device
 
class  playback_usb_device
 
class  playback_uvc_device
 
struct  profile_and_callback
 
class  record_backend
 
class  record_device_watcher
 
class  record_hid_device
 
class  record_usb_device
 
class  record_uvc_device
 
class  recording
 
class  recording_time_service
 
class  retry_controls_work_around
 
struct  sensor_data
 
class  source_reader_callback
 
struct  stream_profile
 
class  time_service
 
struct  tm2_device_info
 
class  usb_device
 
struct  usb_device_info
 
class  usb_enumerate
 
class  usb_interface
 
class  uvc_device
 
struct  uvc_device_info
 
struct  uvc_header
 
class  v4l_backend
 
class  v4l_hid_device
 
class  v4l_usb_device
 
class  v4l_uvc_device
 
class  winapi_error
 
class  winusb_bulk_transfer
 
class  winusb_device
 
class  wmf_backend
 
class  wmf_hid_device
 
class  wmf_uvc_device
 

Typedefs

typedef std::tuple< uint32_t, uint32_t, uint32_t, uint32_t > stream_profile_tuple
 
typedef std::function< void(stream_profile, frame_object, std::function< void()>)> frame_callback
 
typedef std::function< void(const sensor_data &)> hid_callback
 
typedef std::function< void(backend_device_group old, backend_device_group curr)> device_changed_callback
 
typedef std::vector< std::pair< stream_profile, frame_callback > > configurations
 
typedef std::function< void(const uvc_device_info &, IMFActivate *)> enumeration_callback
 

Enumerations

enum  power_state { D0, D3 }
 
enum  usb_spec : uint16_t {
  usb_undefined = 0, usb1_type = 0x0100, usb1_1_type = 0x0110, usb2_type = 0x0200,
  usb2_1_type = 0x0210, usb3_type = 0x0300, usb3_1_type = 0x0310, usb3_2_type = 0x0320
}
 
enum  custom_sensor_report_field {
  minimum, maximum, name, size,
  unit_expo, units, value
}
 
enum  call_type {
  call_type::none, call_type::query_uvc_devices, call_type::query_usb_devices, call_type::send_command,
  call_type::create_usb_device, call_type::create_uvc_device, call_type::uvc_get_location, call_type::uvc_set_power_state,
  call_type::uvc_get_power_state, call_type::uvc_lock, call_type::uvc_unlock, call_type::uvc_get_pu,
  call_type::uvc_set_pu, call_type::uvc_get_pu_range, call_type::uvc_get_xu_range, call_type::uvc_init_xu,
  call_type::uvc_set_xu, call_type::uvc_get_xu, call_type::uvc_stream_profiles, call_type::uvc_probe_commit,
  call_type::uvc_play, call_type::uvc_start_callbacks, call_type::uvc_stop_callbacks, call_type::uvc_close,
  call_type::uvc_frame, call_type::create_hid_device, call_type::query_hid_devices, call_type::hid_open,
  call_type::hid_close, call_type::hid_stop_capture, call_type::hid_start_capture, call_type::hid_frame,
  call_type::hid_get_sensors, call_type::hid_get_custom_report_data, call_type::device_watcher_start, call_type::device_watcher_event,
  call_type::device_watcher_stop, call_type::uvc_get_usb_specification
}
 
enum  create_and_open_status { Mutex_Succeed, Mutex_TotalFailure, Mutex_AlreadyExist }
 
enum  pipe_direction { pipe_direction::InPipe, pipe_direction::OutPipe }
 

Functions

bool operator== (const stream_profile &a, const stream_profile &b)
 
bool operator== (const uvc_device_info &a, const uvc_device_info &b)
 
bool operator== (const usb_device_info &a, const usb_device_info &b)
 
bool operator== (const hid_device_info &a, const hid_device_info &b)
 
bool operator== (const playback_device_info &a, const playback_device_info &b)
 
bool operator== (const tm2_device_info &a, const tm2_device_info &b)
 
std::shared_ptr< backendcreate_backend ()
 
bool check (const char *call, HRESULT hr, bool to_throw=true)
 
std::string win_to_utf (const WCHAR *s)
 
bool is_win10_redstone2 ()
 
std::vector< std::string > tokenize (std::string string, char separator)
 
bool parse_usb_path (uint16_t &vid, uint16_t &pid, uint16_t &mi, std::string &unique_id, const std::string &path)
 
bool get_usb_descriptors (uint16_t device_vid, uint16_t device_pid, const std::string &device_uid, std::string &location, usb_spec &spec)
 

Variables

constexpr uint8_t uvc_header_size = sizeof(uvc_header)
 

Typedef Documentation

§ configurations

§ device_changed_callback

§ enumeration_callback

typedef std::function<void(const uvc_device_info&, IMFActivate*)> librealsense::platform::enumeration_callback

§ frame_callback

typedef std::function<void(stream_profile, frame_object, std::function<void()>)> librealsense::platform::frame_callback

§ hid_callback

typedef std::function<void(const sensor_data&)> librealsense::platform::hid_callback

§ stream_profile_tuple

typedef std::tuple< uint32_t, uint32_t, uint32_t, uint32_t> librealsense::platform::stream_profile_tuple

Enumeration Type Documentation

§ call_type

Enumerator
none 
query_uvc_devices 
query_usb_devices 
send_command 
create_usb_device 
create_uvc_device 
uvc_get_location 
uvc_set_power_state 
uvc_get_power_state 
uvc_lock 
uvc_unlock 
uvc_get_pu 
uvc_set_pu 
uvc_get_pu_range 
uvc_get_xu_range 
uvc_init_xu 
uvc_set_xu 
uvc_get_xu 
uvc_stream_profiles 
uvc_probe_commit 
uvc_play 
uvc_start_callbacks 
uvc_stop_callbacks 
uvc_close 
uvc_frame 
create_hid_device 
query_hid_devices 
hid_open 
hid_close 
hid_stop_capture 
hid_start_capture 
hid_frame 
hid_get_sensors 
hid_get_custom_report_data 
device_watcher_start 
device_watcher_event 
device_watcher_stop 
uvc_get_usb_specification 

§ create_and_open_status

Enumerator
Mutex_Succeed 
Mutex_TotalFailure 
Mutex_AlreadyExist 

§ custom_sensor_report_field

Enumerator
minimum 
maximum 
name 
size 
unit_expo 
units 
value 

§ pipe_direction

Enumerator
InPipe 
OutPipe 

§ power_state

Enumerator
D0 
D3 

§ usb_spec

Enumerator
usb_undefined 
usb1_type 
usb1_1_type 
usb2_type 
usb2_1_type 
usb3_type 
usb3_1_type 
usb3_2_type 

Function Documentation

§ check()

bool librealsense::platform::check ( const char *  call,
HRESULT  hr,
bool  to_throw = true 
)

§ create_backend()

std::shared_ptr<backend> librealsense::platform::create_backend ( )

§ get_usb_descriptors()

bool librealsense::platform::get_usb_descriptors ( uint16_t  device_vid,
uint16_t  device_pid,
const std::string &  device_uid,
std::string &  location,
usb_spec spec 
)

§ is_win10_redstone2()

bool librealsense::platform::is_win10_redstone2 ( )

§ operator==() [1/6]

bool librealsense::platform::operator== ( const stream_profile a,
const stream_profile b 
)
inline

§ operator==() [2/6]

bool librealsense::platform::operator== ( const uvc_device_info a,
const uvc_device_info b 
)
inline

§ operator==() [3/6]

bool librealsense::platform::operator== ( const usb_device_info a,
const usb_device_info b 
)
inline

§ operator==() [4/6]

bool librealsense::platform::operator== ( const hid_device_info a,
const hid_device_info b 
)
inline

§ operator==() [5/6]

bool librealsense::platform::operator== ( const playback_device_info a,
const playback_device_info b 
)
inline

§ operator==() [6/6]

bool librealsense::platform::operator== ( const tm2_device_info a,
const tm2_device_info b 
)
inline

§ parse_usb_path()

bool librealsense::platform::parse_usb_path ( uint16_t &  vid,
uint16_t &  pid,
uint16_t &  mi,
std::string &  unique_id,
const std::string &  path 
)

§ tokenize()

std::vector<std::string> librealsense::platform::tokenize ( std::string  string,
char  separator 
)

§ win_to_utf()

std::string librealsense::platform::win_to_utf ( const WCHAR *  s)

Variable Documentation

§ uvc_header_size

constexpr uint8_t librealsense::platform::uvc_header_size = sizeof(uvc_header)