Intel® RealSense™ Cross Platform API  2.13.0
Intel Realsense Cross-platform API
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
rs2::stream_profile Class Reference

#include <rs_frame.hpp>

Inheritance diagram for rs2::stream_profile:
rs2::motion_stream_profile rs2::video_stream_profile

Public Member Functions

 stream_profile ()
 
int stream_index () const
 
rs2_stream stream_type () const
 
rs2_format format () const
 
int fps () const
 
int unique_id () const
 
stream_profile clone (rs2_stream type, int index, rs2_format format) const
 
bool operator== (const stream_profile &rhs)
 
template<class T >
bool is () const
 
template<class T >
as () const
 
std::string stream_name () const
 
bool is_default () const
 
 operator bool () const
 
const rs2_stream_profileget () const
 
 operator const rs2_stream_profile * ()
 
rs2_extrinsics get_extrinsics_to (const stream_profile &to) const
 
void register_extrinsics_to (const stream_profile &to, rs2_extrinsics extrinsics)
 

Protected Member Functions

 stream_profile (const rs2_stream_profile *profile)
 

Protected Attributes

const rs2_stream_profile_profile
 
std::shared_ptr< rs2_stream_profile_clone
 
int _index = 0
 
int _uid = 0
 
int _framerate = 0
 
rs2_format _format = RS2_FORMAT_ANY
 
rs2_stream _type = RS2_STREAM_ANY
 
bool _default = false
 

Friends

class rs2::sensor
 
class rs2::frame
 
class rs2::pipeline_profile
 
class software_sensor
 

Constructor & Destructor Documentation

◆ stream_profile() [1/2]

rs2::stream_profile::stream_profile ( )
inline

◆ stream_profile() [2/2]

rs2::stream_profile::stream_profile ( const rs2_stream_profile profile)
inlineexplicitprotected

Member Function Documentation

◆ as()

template<class T >
T rs2::stream_profile::as ( ) const
inline

◆ clone()

stream_profile rs2::stream_profile::clone ( rs2_stream  type,
int  index,
rs2_format  format 
) const
inline

◆ format()

rs2_format rs2::stream_profile::format ( ) const
inline

◆ fps()

int rs2::stream_profile::fps ( ) const
inline

◆ get()

const rs2_stream_profile* rs2::stream_profile::get ( ) const
inline

◆ get_extrinsics_to()

rs2_extrinsics rs2::stream_profile::get_extrinsics_to ( const stream_profile to) const
inline

◆ is()

template<class T >
bool rs2::stream_profile::is ( ) const
inline

◆ is_default()

bool rs2::stream_profile::is_default ( ) const
inline

◆ operator bool()

rs2::stream_profile::operator bool ( ) const
inline

◆ operator const rs2_stream_profile *()

rs2::stream_profile::operator const rs2_stream_profile * ( )
inline

◆ operator==()

bool rs2::stream_profile::operator== ( const stream_profile rhs)
inline

◆ register_extrinsics_to()

void rs2::stream_profile::register_extrinsics_to ( const stream_profile to,
rs2_extrinsics  extrinsics 
)
inline

◆ stream_index()

int rs2::stream_profile::stream_index ( ) const
inline

◆ stream_name()

std::string rs2::stream_profile::stream_name ( ) const
inline

◆ stream_type()

rs2_stream rs2::stream_profile::stream_type ( ) const
inline

◆ unique_id()

int rs2::stream_profile::unique_id ( ) const
inline

Friends And Related Function Documentation

◆ rs2::frame

friend class rs2::frame
friend

◆ rs2::pipeline_profile

friend class rs2::pipeline_profile
friend

◆ rs2::sensor

friend class rs2::sensor
friend

◆ software_sensor

friend class software_sensor
friend

Member Data Documentation

◆ _clone

std::shared_ptr<rs2_stream_profile> rs2::stream_profile::_clone
protected

◆ _default

bool rs2::stream_profile::_default = false
protected

◆ _format

rs2_format rs2::stream_profile::_format = RS2_FORMAT_ANY
protected

◆ _framerate

int rs2::stream_profile::_framerate = 0
protected

◆ _index

int rs2::stream_profile::_index = 0
protected

◆ _profile

const rs2_stream_profile* rs2::stream_profile::_profile
protected

◆ _type

rs2_stream rs2::stream_profile::_type = RS2_STREAM_ANY
protected

◆ _uid

int rs2::stream_profile::_uid = 0
protected

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