EncodedFrame
Outputs EncodedFrame message that carries encoded (MJPEG, H264 or H265) frame data. Source of this message is VideoEncoder node.Reference
class
depthai.EncodedFrame(depthai.Buffer)
class
FrameType
Members: I P B Unknown
class
Profile
Members: JPEG AVC HEVC
method
method
getBitrate(self) -> int: intRetrieves the encoding bitrate
method
getColorTemperature(self) -> int: intRetrieves white-balance color temperature of the light source, in kelvins
method
getExposureTime(self) -> datetime.timedelta: datetime.timedeltaRetrieves exposure time
method
getFrameType(self) -> RawEncodedFrame.FrameType: RawEncodedFrame.FrameTypeRetrieves frame type (H26x only)
method
getHeight(self) -> int: intRetrieves image height in pixels
method
getInstanceNum(self) -> int: intRetrieves instance number
method
getLensPosition(self) -> int: intRetrieves lens position, range 0..255. Returns -1 if not available
method
getLensPositionRaw(self) -> float: floatRetrieves lens position, range 0.0f..1.0f. Returns -1 if not available
method
getLossless(self) -> bool: boolReturns true if encoding is lossless (JPEG only)
method
getProfile(self) -> RawEncodedFrame.Profile: RawEncodedFrame.ProfileRetrieves the encoding profile (JPEG, AVC or HEVC)
method
getQuality(self) -> int: intRetrieves the encoding quality
method
getSensitivity(self) -> int: intRetrieves sensitivity, as an ISO value
method
getSequenceNum(self) -> int: intRetrieves sequence number
method
getTimestamp(self) -> datetime.timedelta: datetime.timedeltaRetrieves timestamp related to dai::Clock::now()
method
getTimestampDevice(self) -> datetime.timedelta: datetime.timedeltaRetrieves timestamp directly captured from device's monotonic clock, not synchronized to host time. Used mostly for debugging
method
getWidth(self) -> int: intRetrieves image width in pixels
method
setBitrate(self, arg0: int) -> EncodedFrame: EncodedFrameRetrieves the encoding bitrate
method
setFrameType(self, arg0: RawEncodedFrame.FrameType) -> EncodedFrame: EncodedFrameRetrieves frame type (H26x only)
method
setHeight(self, arg0: int) -> EncodedFrame: EncodedFrameSpecifies frame height Parameter ``height``: frame height
method
setLossless(self, arg0: bool) -> EncodedFrame: EncodedFrameReturns true if encoding is lossless (JPEG only)
method
setProfile(self, arg0: RawEncodedFrame.Profile) -> EncodedFrame: EncodedFrameRetrieves the encoding profile (JPEG, AVC or HEVC)
method
setQuality(self, arg0: int) -> EncodedFrame: EncodedFrameRetrieves the encoding quality
method
setSequenceNum(self, arg0: int) -> EncodedFrame: EncodedFrameSpecifies sequence number Parameter ``seq``: Sequence number
method
setTimestamp(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrameRetrieves image timestamp related to dai::Clock::now()
method
setTimestampDevice(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrameSets image timestamp related to dai::Clock::now()
method
setWidth(self, arg0: int) -> EncodedFrame: EncodedFrameSpecifies frame width Parameter ``width``: frame width
class
depthai.EncodedFrame.FrameType
variable
variable
variable
variable
variable
method
method
method
method
method
method
method
method
method
method
property
property
class
depthai.EncodedFrame.Profile
variable
variable
variable
variable
method
method
method
method
method
method
method
method
method
method
property
property
Need assistance?
Head over to Discussion Forum for technical support or any other questions you might have.