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: int
Retrieves the encoding bitrate
method
getColorTemperature(self) -> int: int
Retrieves white-balance color temperature of the light source, in kelvins
method
getExposureTime(self) -> datetime.timedelta: datetime.timedelta
Retrieves exposure time
method
getFrameType(self) -> RawEncodedFrame.FrameType: RawEncodedFrame.FrameType
Retrieves frame type (H26x only)
method
getInstanceNum(self) -> int: int
Retrieves instance number
method
getLensPosition(self) -> int: int
Retrieves lens position, range 0..255. Returns -1 if not available
method
getLensPositionRaw(self) -> float: float
Retrieves lens position, range 0.0f..1.0f. Returns -1 if not available
method
getLossless(self) -> bool: bool
Returns true if encoding is lossless (JPEG only)
method
getProfile(self) -> RawEncodedFrame.Profile: RawEncodedFrame.Profile
Retrieves the encoding profile (JPEG, AVC or HEVC)
method
getQuality(self) -> int: int
Retrieves the encoding quality
method
getSensitivity(self) -> int: int
Retrieves sensitivity, as an ISO value
method
getSequenceNum(self) -> int: int
Retrieves sequence number
method
getTimestamp(self) -> datetime.timedelta: datetime.timedelta
Retrieves timestamp related to dai::Clock::now()
method
getTimestampDevice(self) -> datetime.timedelta: datetime.timedelta
Retrieves timestamp directly captured from device's monotonic clock, not synchronized to host time. Used mostly for debugging
method
setBitrate(self, arg0: int) -> EncodedFrame: EncodedFrame
Retrieves the encoding bitrate
method
setFrameType(self, arg0: RawEncodedFrame.FrameType) -> EncodedFrame: EncodedFrame
Retrieves frame type (H26x only)
method
setLossless(self, arg0: bool) -> EncodedFrame: EncodedFrame
Returns true if encoding is lossless (JPEG only)
method
setProfile(self, arg0: RawEncodedFrame.Profile) -> EncodedFrame: EncodedFrame
Retrieves the encoding profile (JPEG, AVC or HEVC)
method
setQuality(self, arg0: int) -> EncodedFrame: EncodedFrame
Retrieves the encoding quality
method
setSequenceNum(self, arg0: int) -> EncodedFrame: EncodedFrame
Specifies sequence number Parameter ``seq``: Sequence number
method
setTimestamp(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrame
Retrieves image timestamp related to dai::Clock::now()
method
setTimestampDevice(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrame
Sets image timestamp related to dai::Clock::now()
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.