ob::StreamProfileList Class Reference

#include <StreamProfile.hpp>

Public Member Functions
	StreamProfileList (ob_stream_profile_list_t *impl)
	~StreamProfileList () noexcept
uint32_t	getCount () const
	Return the number of StreamProfile objects.
std::shared_ptr< StreamProfile >	getProfile (uint32_t index) const
	Return the StreamProfile object at the specified index.
std::shared_ptr< VideoStreamProfile >	getVideoStreamProfile (int width=OB_WIDTH_ANY, int height=OB_HEIGHT_ANY, OBFormat format=OB_FORMAT_ANY, int fps=OB_FPS_ANY) const
	Match the corresponding video stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
std::shared_ptr< AccelStreamProfile >	getAccelStreamProfile (OBAccelFullScaleRange fullScaleRange, OBAccelSampleRate sampleRate) const
	Match the corresponding accelerometer stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
std::shared_ptr< GyroStreamProfile >	getGyroStreamProfile (OBGyroFullScaleRange fullScaleRange, OBGyroSampleRate sampleRate) const
	Match the corresponding gyroscope stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.
uint32_t	count () const

Protected Attributes
const ob_stream_profile_list_t *	impl_

Detailed Description

Definition at line 430 of file StreamProfile.hpp.

Constructor & Destructor Documentation

StreamProfileList()

ob::StreamProfileList::StreamProfileList ( ob_stream_profile_list_t * impl )

inlineexplicit

Definition at line 435 of file StreamProfile.hpp.

~StreamProfileList()

ob::StreamProfileList::~StreamProfileList ( )

inlinenoexcept

Definition at line 436 of file StreamProfile.hpp.

Member Function Documentation

getCount()

uint32_t ob::StreamProfileList::getCount ( ) const

inline

Return the number of StreamProfile objects.

Returns

uint32_t Return the number of StreamProfile objects.

Definition at line 447 of file StreamProfile.hpp.

Referenced by count().

getProfile()

std::shared_ptr< StreamProfile > ob::StreamProfileList::getProfile ( uint32_t index ) const

inline

Return the StreamProfile object at the specified index.

Parameters

index

The index of the StreamProfile object to be retrieved. Must be in the range [0, count-1]. Throws an exception if the index is out of range.

Returns

std::shared_ptr<StreamProfile> Return the StreamProfile object.

Definition at line 460 of file StreamProfile.hpp.

getVideoStreamProfile()

std::shared_ptr< VideoStreamProfile > ob::StreamProfileList::getVideoStreamProfile ( int width = OB_WIDTH_ANY, int height = OB_HEIGHT_ANY, OBFormat format = OB_FORMAT_ANY, int fps = OB_FPS_ANY ) const

inline

Match the corresponding video stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.

Parameters

width	The width of the stream. Pass OB_WIDTH_ANY if no matching condition is required.
height	The height of the stream. Pass OB_HEIGHT_ANY if no matching condition is required.
format	The type of the stream. Pass OB_FORMAT_ANY if no matching condition is required.
fps	The frame rate of the stream. Pass OB_FPS_ANY if no matching condition is required.

Returns

std::shared_ptr<VideoStreamProfile> Return the matching resolution.

Definition at line 477 of file StreamProfile.hpp.

getAccelStreamProfile()

std::shared_ptr< AccelStreamProfile > ob::StreamProfileList::getAccelStreamProfile ( OBAccelFullScaleRange fullScaleRange, OBAccelSampleRate sampleRate ) const

inline

Match the corresponding accelerometer stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.

Parameters

fullScaleRange	The full scale range. Pass 0 if no matching condition is required.
sampleRate	The sampling frequency. Pass 0 if no matching condition is required.

Definition at line 493 of file StreamProfile.hpp.

getGyroStreamProfile()

std::shared_ptr< GyroStreamProfile > ob::StreamProfileList::getGyroStreamProfile ( OBGyroFullScaleRange fullScaleRange, OBGyroSampleRate sampleRate ) const

inline

Match the corresponding gyroscope stream profile based on the passed-in parameters. If multiple Match are found, the first one in the list is returned by default. Throws an exception if no matching profile is found.

Parameters

fullScaleRange	The full scale range. Pass 0 if no matching condition is required.
sampleRate	The sampling frequency. Pass 0 if no matching condition is required.

Definition at line 508 of file StreamProfile.hpp.

count()

uint32_t ob::StreamProfileList::count ( ) const

inline

Definition at line 518 of file StreamProfile.hpp.

Referenced by getCount().

Member Data Documentation

impl_

const ob_stream_profile_list_t* ob::StreamProfileList::impl_

protected

Definition at line 432 of file StreamProfile.hpp.

Referenced by getAccelStreamProfile(), getCount(), getGyroStreamProfile(), getProfile(), getVideoStreamProfile(), StreamProfileList(), and ~StreamProfileList().

---

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

• E:/jenkins/workspace/OrbbecSDK/build_sdk/OpenOrbbecSDK/include/libobsensor/hpp/StreamProfile.hpp