dai::EncodedFrame Class Reference

#include <EncodedFrame.hpp>

Inheritance diagram for dai::EncodedFrame:

Public Types
using	FrameType = RawEncodedFrame::FrameType
using	Profile = RawEncodedFrame::Profile

Public Member Functions
	EncodedFrame ()
	EncodedFrame (std::shared_ptr< RawEncodedFrame > ptr)
unsigned int	getBitrate () const
int	getColorTemperature () const
std::chrono::microseconds	getExposureTime () const
FrameType	getFrameType () const
unsigned int	getHeight () const
unsigned int	getInstanceNum () const
int	getLensPosition () const
float	getLensPositionRaw () const
bool	getLossless () const
Profile	getProfile () const
unsigned int	getQuality () const
int	getSensitivity () const
unsigned int	getWidth () const
EncodedFrame &	setBitrate (unsigned int bitrate)
EncodedFrame &	setFrameType (FrameType type)
EncodedFrame &	setHeight (unsigned int height)
EncodedFrame &	setInstanceNum (unsigned int instance)
EncodedFrame &	setLossless (bool lossless)
EncodedFrame &	setProfile (Profile profile)
EncodedFrame &	setQuality (unsigned int quality)
EncodedFrame &	setSequenceNum (int64_t seq)
EncodedFrame &	setTimestamp (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > tp)
EncodedFrame &	setTimestampDevice (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > tp)
EncodedFrame &	setWidth (unsigned int width)
virtual	~EncodedFrame ()=default
Public Member Functions inherited from dai::Buffer
	Buffer ()
	Creates Buffer message. More...
	Buffer (std::shared_ptr< dai::RawBuffer > ptr)
std::vector< std::uint8_t > &	getData () const
	Get non-owning reference to internal buffer. More...
int64_t	getSequenceNum () const
std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration >	getTimestamp () const
std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration >	getTimestampDevice () const
void	setData (const std::vector< std::uint8_t > &data)
void	setData (std::vector< std::uint8_t > &&data)
Buffer &	setSequenceNum (int64_t sequenceNum)
Buffer &	setTimestamp (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > timestamp)
Buffer &	setTimestampDevice (std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration > timestamp)
virtual	~Buffer ()=default
Public Member Functions inherited from dai::ADatatype
	ADatatype (std::shared_ptr< RawBuffer > r)
std::shared_ptr< RawBuffer >	getRaw () const
virtual	~ADatatype ()=default

Private Member Functions
std::shared_ptr< RawBuffer >	serialize () const override

Private Attributes
RawEncodedFrame &	frame

Additional Inherited Members
Protected Attributes inherited from dai::ADatatype
std::shared_ptr< RawBuffer >	raw

Detailed Description

Definition at line 17 of file EncodedFrame.hpp.

Member Typedef Documentation

FrameType

using dai::EncodedFrame::FrameType = RawEncodedFrame::FrameType

Definition at line 24 of file EncodedFrame.hpp.

Profile

using dai::EncodedFrame::Profile = RawEncodedFrame::Profile

Definition at line 23 of file EncodedFrame.hpp.

Constructor & Destructor Documentation

EncodedFrame() [1/2]

dai::EncodedFrame::EncodedFrame

(

)

Construct EncodedFrame message. Timestamp is set to now

Definition at line 11 of file EncodedFrame.cpp.

EncodedFrame() [2/2]

dai::EncodedFrame::EncodedFrame ( std::shared_ptr< RawEncodedFrame >  ptr )

explicit

Definition at line 15 of file EncodedFrame.cpp.

~EncodedFrame()

virtual dai::EncodedFrame::~EncodedFrame ( )

virtualdefault

Member Function Documentation

getBitrate()

unsigned int dai::EncodedFrame::getBitrate

(

)

const

Retrieves the encoding bitrate

Definition at line 45 of file EncodedFrame.cpp.

getColorTemperature()

int dai::EncodedFrame::getColorTemperature

(

)

const

Retrieves white-balance color temperature of the light source, in kelvins

Definition at line 33 of file EncodedFrame.cpp.

getExposureTime()

std::chrono::microseconds dai::EncodedFrame::getExposureTime

(

)

const

Retrieves exposure time

Definition at line 27 of file EncodedFrame.cpp.

getFrameType()

EncodedFrame::FrameType dai::EncodedFrame::getFrameType

(

)

const

Retrieves frame type (H26x only)

Definition at line 51 of file EncodedFrame.cpp.

getHeight()

unsigned int dai::EncodedFrame::getHeight

(

)

const

Retrieves image height in pixels

Definition at line 24 of file EncodedFrame.cpp.

getInstanceNum()

unsigned int dai::EncodedFrame::getInstanceNum

(

)

const

Retrieves instance number

Definition at line 18 of file EncodedFrame.cpp.

getLensPosition()

int dai::EncodedFrame::getLensPosition

(

)

const

Retrieves lens position, range 0..255. Returns -1 if not available

Definition at line 36 of file EncodedFrame.cpp.

getLensPositionRaw()

float dai::EncodedFrame::getLensPositionRaw

(

)

const

Retrieves lens position, range 0.0f..1.0f. Returns -1 if not available

Definition at line 39 of file EncodedFrame.cpp.

getLossless()

bool dai::EncodedFrame::getLossless

(

)

const

Returns true if encoding is lossless (JPEG only)

Definition at line 48 of file EncodedFrame.cpp.

getProfile()

EncodedFrame::Profile dai::EncodedFrame::getProfile

(

)

const

Retrieves the encoding profile (JPEG, AVC or HEVC)

Definition at line 88 of file EncodedFrame.cpp.

getQuality()

unsigned int dai::EncodedFrame::getQuality

(

)

const

Retrieves the encoding quality

Definition at line 42 of file EncodedFrame.cpp.

getSensitivity()

int dai::EncodedFrame::getSensitivity

(

)

const

Retrieves sensitivity, as an ISO value

Definition at line 30 of file EncodedFrame.cpp.

getWidth()

unsigned int dai::EncodedFrame::getWidth

(

)

const

Retrieves image width in pixels

Definition at line 21 of file EncodedFrame.cpp.

serialize()

std::shared_ptr< RawBuffer > dai::EncodedFrame::serialize ( ) const

overrideprivatevirtual

Reimplemented from dai::Buffer.

Definition at line 7 of file EncodedFrame.cpp.

setBitrate()

EncodedFrame & dai::EncodedFrame::setBitrate

(

unsigned int

bitrate

)

Specifies the encoding quality

Parameters

quality

Encoding quality

Definition at line 120 of file EncodedFrame.cpp.

setFrameType()

EncodedFrame & dai::EncodedFrame::setFrameType

(

FrameType

type

)

Specifies the frame type (H26x only)

Parameters

type	Type of h26x frame (I, P, B)

Definition at line 129 of file EncodedFrame.cpp.

setHeight()

EncodedFrame & dai::EncodedFrame::setHeight

(

unsigned int

height

)

Specifies frame height

Parameters

height

frame height

Definition at line 112 of file EncodedFrame.cpp.

setInstanceNum()

EncodedFrame & dai::EncodedFrame::setInstanceNum

(

unsigned int

instance

)

Instance number relates to the origin of the frame (which camera)

Parameters

instance

Instance number

Definition at line 104 of file EncodedFrame.cpp.

setLossless()

EncodedFrame & dai::EncodedFrame::setLossless

(

bool

lossless

)

Specifies if encoding is lossless (JPEG only)

Parameters

lossless

True if lossless

Definition at line 125 of file EncodedFrame.cpp.

setProfile()

EncodedFrame & dai::EncodedFrame::setProfile

(

Profile

profile

)

Specifies the encoding profile

Parameters

profile

Encoding profile

Definition at line 133 of file EncodedFrame.cpp.

setQuality()

EncodedFrame & dai::EncodedFrame::setQuality

(

unsigned int

quality

)

Specifies the encoding quality

Parameters

quality

Encoding quality

Definition at line 116 of file EncodedFrame.cpp.

setSequenceNum()

EncodedFrame & dai::EncodedFrame::setSequenceNum

(

int64_t

seq

)

Specifies sequence number

Parameters

seq	Sequence number

Definition at line 101 of file EncodedFrame.cpp.

setTimestamp()

EncodedFrame & dai::EncodedFrame::setTimestamp

(

std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration >

tp

)

Retrieves image timestamp related to dai::Clock::now()

Definition at line 93 of file EncodedFrame.cpp.

setTimestampDevice()

EncodedFrame & dai::EncodedFrame::setTimestampDevice

(

std::chrono::time_point< std::chrono::steady_clock, std::chrono::steady_clock::duration >

tp

)

Sets image timestamp related to dai::Clock::now()

Definition at line 97 of file EncodedFrame.cpp.

setWidth()

EncodedFrame & dai::EncodedFrame::setWidth

(

unsigned int

width

)

Specifies frame width

Parameters

width

frame width

Definition at line 108 of file EncodedFrame.cpp.

Member Data Documentation

frame

RawEncodedFrame& dai::EncodedFrame::frame

private

Definition at line 19 of file EncodedFrame.hpp.

---

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

• EncodedFrame.hpp
• EncodedFrame.cpp