ob::VideoStreamProfile Class Reference

Class representing a video stream profile. More...

#include <StreamProfile.hpp>

Inheritance diagram for ob::VideoStreamProfile:

Public Member Functions
	VideoStreamProfile (const ob_stream_profile_t *impl)
	~VideoStreamProfile () noexcept override=default
uint32_t	getFps () const
	Return the frame rate of the stream.
uint32_t	getWidth () const
	Return the width of the stream.
uint32_t	getHeight () const
	Return the height of the stream.
OBCameraIntrinsic	getIntrinsic () const
	Get the intrinsic parameters of the stream.
OBCameraDistortion	getDistortion () const
	Get the distortion parameters of the stream.
uint32_t	fps () const
uint32_t	width () const
uint32_t	height () const
Public Member Functions inherited from ob::StreamProfile
	StreamProfile (StreamProfile &streamProfile)=delete
StreamProfile &	operator= (StreamProfile &streamProfile)=delete
	StreamProfile (StreamProfile &&streamProfile) noexcept
StreamProfile &	operator= (StreamProfile &&streamProfile) noexcept
virtual	~StreamProfile () noexcept
const ob_stream_profile *	getImpl () const
OBFormat	getFormat () const
	Get the format of the stream.
OBStreamType	getType () const
	Get the type of stream.
OBExtrinsic	getExtrinsicTo (std::shared_ptr< StreamProfile > target) const
	Get the extrinsic parameters from current stream profile to the given target stream profile.
template<typename T >
bool	is () const
	Check if frame object is compatible with the given type.
template<typename T >
std::shared_ptr< T >	as ()
	Converts object type to target type.
template<typename T >
std::shared_ptr< const T >	as () const
	Converts object type to target type (const version)
OBFormat	format () const
OBStreamType	type () const

Additional Inherited Members
Protected Member Functions inherited from ob::StreamProfile
	StreamProfile (const ob_stream_profile_t *impl)
Protected Attributes inherited from ob::StreamProfile
const ob_stream_profile_t *	impl_ = nullptr

Detailed Description

Class representing a video stream profile.

Definition at line 141 of file StreamProfile.hpp.

Constructor & Destructor Documentation

VideoStreamProfile()

ob::VideoStreamProfile::VideoStreamProfile ( const ob_stream_profile_t * impl )

inlineexplicit

Definition at line 143 of file StreamProfile.hpp.

~VideoStreamProfile()

ob::VideoStreamProfile::~VideoStreamProfile ( )

overridedefaultnoexcept

Member Function Documentation

getFps()

uint32_t ob::VideoStreamProfile::getFps ( ) const

inline

Return the frame rate of the stream.

Returns

uint32_t Return the frame rate of the stream.

Definition at line 152 of file StreamProfile.hpp.

Referenced by fps().

getWidth()

uint32_t ob::VideoStreamProfile::getWidth ( ) const

inline

Return the width of the stream.

Returns

uint32_t Return the width of the stream.

Definition at line 164 of file StreamProfile.hpp.

Referenced by width().

getHeight()

uint32_t ob::VideoStreamProfile::getHeight ( ) const

inline

Return the height of the stream.

Returns

uint32_t Return the height of the stream.

Definition at line 176 of file StreamProfile.hpp.

Referenced by height().

getIntrinsic()

OBCameraIntrinsic ob::VideoStreamProfile::getIntrinsic ( ) const

inline

Get the intrinsic parameters of the stream.

Returns

OBCameraIntrinsic Return the intrinsic parameters.

Definition at line 188 of file StreamProfile.hpp.

getDistortion()

OBCameraDistortion ob::VideoStreamProfile::getDistortion ( ) const

inline

Get the distortion parameters of the stream.

Brown distortion model

Returns

OBCameraDistortion Return the distortion parameters.

Definition at line 201 of file StreamProfile.hpp.

fps()

uint32_t ob::VideoStreamProfile::fps ( ) const

inline

Definition at line 210 of file StreamProfile.hpp.

Referenced by getFps().

width()

uint32_t ob::VideoStreamProfile::width ( ) const

inline

Definition at line 214 of file StreamProfile.hpp.

Referenced by getWidth().

height()

uint32_t ob::VideoStreamProfile::height ( ) const

inline

Definition at line 218 of file StreamProfile.hpp.

Referenced by getHeight().

---

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

• C:/Users/hzcyf/Projects/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/StreamProfile.hpp