CloudSoftwareHardware
Software Stack
DepthAI
OAK Apps
AI Models

ON THIS PAGE

  • EncodedFrame
  • Reference

EncodedFrame

Outputs EncodedFrame message that carries encoded (MJPEG, H264 or H265) frame data. Source of this message is VideoEncoder node.

Reference

class

dai::EncodedFrame

variable
variable
uint32_t instanceNum
variable
unsigned int width
variable
unsigned int height
variable
uint32_t quality
variable
uint32_t bitrate
variable
Profile profile
variable
bool lossless
variable
FrameType type
variable
uint32_t frameOffset
variable
uint32_t frameSize
variable
ImgTransformation transformation
function
~EncodedFrame()
function
unsigned int getInstanceNum()
Retrieves instance number
function
unsigned int getWidth()
Retrieves image width in pixels
function
unsigned int getHeight()
Retrieves image height in pixels
function
std::chrono::microseconds getExposureTime()
Retrieves exposure time
function
int getSensitivity()
Retrieves sensitivity, as an ISO value
function
int getColorTemperature()
Retrieves white-balance color temperature of the light source, in kelvins
function
int getLensPosition()
Retrieves lens position, range 0..255. Returns -1 if not available
function
float getLensPositionRaw()
Retrieves lens position, range 0.0f..1.0f. Returns -1 if not available
function
unsigned int getQuality()
Retrieves the encoding quality
function
unsigned int getBitrate()
Retrieves the encoding bitrate
function
bool getLossless()
Returns true if encoding is lossless (JPEG only)
function
FrameType getFrameType()
Retrieves frame type (H26x only)
function
Profile getProfile()
Retrieves the encoding profile (JPEG, AVC or HEVC)
function
EncodedFrame & setInstanceNum(unsigned int instance)
Instance number relates to the origin of the frame (which camera)
Parameters
  • instance: Instance number
function
EncodedFrame & setWidth(unsigned int width)
Specifies frame width
Parameters
  • width: frame width
function
EncodedFrame & setHeight(unsigned int height)
Specifies frame height
Parameters
  • height: frame height
function
EncodedFrame & setSize(unsigned int width, unsigned int height)
Specifies frame size
Parameters
  • height: frame height
  • width: frame width
function
EncodedFrame & setSize(std::tuple< unsigned int, unsigned int > size)
Specifies frame size
Parameters
  • size: frame size
function
EncodedFrame & setQuality(unsigned int quality)
Specifies the encoding quality
Parameters
  • quality: Encoding quality
function
EncodedFrame & setBitrate(unsigned int bitrate)
Specifies the encoding quality
Parameters
  • quality: Encoding quality
function
EncodedFrame & setLossless(bool lossless)
Specifies if encoding is lossless (JPEG only)
Parameters
  • lossless: True if lossless
function
EncodedFrame & setFrameType(FrameType type)
Specifies the frame type (H26x only)
Parameters
  • type: Type of h26x frame (I, P, B)
function
EncodedFrame & setProfile(Profile profile)
Specifies the encoding profile
Parameters
  • profile: Encoding profile
function
ImgFrame getImgFrameMeta()
inline function
void serialize(std::vector< std::uint8_t > & metadata, DatatypeEnum & datatype)
function
DEPTHAI_SERIALIZE(EncodedFrame, cam, instanceNum, width, height, quality, bitrate, profile, lossless, type, frameOffset, frameSize, transformation, Buffer::sequenceNum, Buffer::ts, Buffer::tsDevice)
enum

std::uint8_t Profile

enumerator
JPEG
enumerator
AVC
enumerator
HEVC
enum

std::uint8_t FrameType

enumerator
I
enumerator
P
enumerator
B
enumerator
Unknown
enum

Need assistance?

Head over to Discussion Forum for technical support or any other questions you might have.