rs2::stream_profile Class Reference
#include <rs_frame.hpp>
Inheritance diagram for rs2::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> | |
| T | as () const |
| std::string | stream_name () const |
| bool | is_default () const |
| operator bool () const | |
| const rs2_stream_profile * | get () const |
| rs2_extrinsics | get_extrinsics_to (const stream_profile &to) const |
| void | register_extrinsics_to (const stream_profile &to, rs2_extrinsics extrinsics) |
| bool | is_cloned () |
| stream_profile (const rs2_stream_profile *profile) | |
| operator const rs2_stream_profile * () | |
| operator std::shared_ptr< rs2_stream_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 | rs2::video_stream_profile |
Constructor & Destructor Documentation
◆ stream_profile() [1/2]
|
inline |
Class to store the profile of stream
◆ stream_profile() [2/2]
|
inlineexplicit |
Member Function Documentation
◆ as()
template<class T>
|
inline |
Template function, casting the instance as another class type
- Returns
- class instance - pointer or null.
◆ clone()
|
inline |
Clone the current profile and change the type, index and format to input parameters
- Parameters
-
[in] type - will change the stream type from the cloned profile. [in] index - will change the stream index from the cloned profile. [in] format - will change the stream format from the cloned profile.
- Returns
- stream_profile - return the cloned stream profile.
◆ format()
|
inline |
Return the stream format
- Returns
- rs2_format - stream format
◆ fps()
|
inline |
Return the stream frame per second
- Returns
- int - frame rate
◆ get()
|
inline |
Get back the internal stream profile instance
- Returns
- rs2_stream_profile* - internal implementation of the profile class
◆ get_extrinsics_to()
|
inline |
Operator implement, return the internal stream profile instance.
- Returns
- rs2_stream_profile* - internal instance to communicate with real implementation. Get the extrinsic transformation between two profiles (representing physical sensors)
- Parameters
-
[in] stream_profile to - the stream profile (another sensor) to be based to return the extrinsic
- Returns
- rs2_stream_profile* - internal instance to communicate with real implementation.
◆ is()
template<class T>
|
inline |
Template function, checking if the instance belongs to specific class type
- Returns
- bool - true or false.
◆ is_cloned()
|
inline |
◆ is_default()
|
inline |
Checks if stream profile is marked/assigned as default, meaning that the profile will be selected when the user requests stream configuration using wildcards (RS2_DEPTH, -1,-1,...
- Returns
- bool - true or false.
◆ operator bool()
|
inline |
Checks if the profile is valid
- Returns
- bool - true or false.
◆ operator const rs2_stream_profile *()
|
inline |
◆ operator std::shared_ptr< rs2_stream_profile >()
|
inlineexplicit |
◆ operator==()
|
inline |
Comparison operator, compare if two stream profiles are the same
- Parameters
-
[in] rhs - stream profile to compare with.
- Returns
- bool - true or false.
◆ register_extrinsics_to()
|
inline |
Assign extrinsic transformation parameters to a specific profile (sensor). The extrinsic information is generally available as part of the camera calibration, and librealsense is responsible for retrieving and assigning these parameters where appropriate. This specific function is intended for synthetic/mock-up (software) devices for which the parameters are produced and injected by the user.
- Parameters
-
[in] stream_profile to - which stream profile to be registered with the extrinsic. [in] rs2_extrinsics extrinsics - the extrinsics to be registered.
◆ stream_index()
|
inline |
Return the specific stream index
- Returns
- int - stream index
◆ stream_name()
|
inline |
Return the string of stream name
- Returns
- string - stream name.
◆ stream_type()
|
inline |
Return the stream type
- Returns
- rs2_stream - stream type
◆ unique_id()
|
inline |
Return the assigned unique index when the stream was created
- Returns
- int - unique id
Friends And Related Symbol Documentation
◆ rs2::frame
|
friend |
◆ rs2::pipeline_profile
|
friend |
◆ rs2::sensor
|
friend |
◆ rs2::video_stream_profile
|
friend |
Member Data Documentation
◆ _clone
|
protected |
◆ _default
|
protected |
◆ _format
|
protected |
◆ _framerate
|
protected |
◆ _index
|
protected |
◆ _profile
|
protected |
◆ _type
|
protected |
◆ _uid
|
protected |
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/librealsense-2.58.2-build/librealsense-2.58.2/include/librealsense2/hpp/rs_frame.hpp
Generated by
1.17.0