Class EncodedFrame

Defined in File EncodedFrame.hpp

Inheritance Relationships

Base Type

public dai::Buffer (Class Buffer)

Class Documentation

class EncodedFrame : public dai::Buffer 

Public Types

using Profile = RawEncodedFrame::Profile

using FrameType = RawEncodedFrame::FrameType

Public Functions

EncodedFrame(): Construct EncodedFrame message. Timestamp is set to now

explicit EncodedFrame(std::shared_ptr<RawEncodedFrame> ptr)

virtual ~EncodedFrame() = default

unsigned int getInstanceNum() const: Retrieves instance number

unsigned int getWidth() const: Retrieves image width in pixels

unsigned int getHeight() const: Retrieves image height in pixels

std::chrono::microseconds getExposureTime() const: Retrieves exposure time

int getSensitivity() const: Retrieves sensitivity, as an ISO value

int getColorTemperature() const: Retrieves white-balance color temperature of the light source, in kelvins

int getLensPosition() const: Retrieves lens position, range 0..255. Returns -1 if not available

float getLensPositionRaw() const: Retrieves lens position, range 0.0f..1.0f. Returns -1 if not available

unsigned int getQuality() const: Retrieves the encoding quality

unsigned int getBitrate() const: Retrieves the encoding bitrate

bool getLossless() const: Returns true if encoding is lossless (JPEG only)

FrameType getFrameType() const: Retrieves frame type (H26x only)

Profile getProfile() const: Retrieves the encoding profile (JPEG, AVC or HEVC)

EncodedFrame &setTimestamp(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> tp): Retrieves image timestamp related to dai::Clock::now()

EncodedFrame &setTimestampDevice(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> tp): Sets image timestamp related to dai::Clock::now()

EncodedFrame &setSequenceNum(int64_t seq)

Specifies sequence number

Parameters:: seq – Sequence number

EncodedFrame &setInstanceNum(unsigned int instance)

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

Parameters:: instance – Instance number

EncodedFrame &setWidth(unsigned int width)

Specifies frame width

Parameters:: width – frame width

EncodedFrame &setHeight(unsigned int height)

Specifies frame height

Parameters:: height – frame height

EncodedFrame &setQuality(unsigned int quality)

Specifies the encoding quality

Parameters:: quality – Encoding quality

EncodedFrame &setBitrate(unsigned int bitrate)

Specifies the encoding quality

Parameters:: quality – Encoding quality

EncodedFrame &setLossless(bool lossless)

Specifies if encoding is lossless (JPEG only)

Parameters:: lossless – True if lossless

EncodedFrame &setFrameType(FrameType type)

Specifies the frame type (H26x only)

Parameters:: type – Type of h26x frame (I, P, B)

EncodedFrame &setProfile(Profile profile)

Specifies the encoding profile

Parameters:: profile – Encoding profile