# EncodedFrame

Outputs EncodedFrame message that carries encoded (MJPEG, H264 or H265) frame data. Source of this message is
[VideoEncoder](https://docs.luxonis.com/software/depthai-components/nodes/video_encoder.md) node.

## Reference

### depthai.EncodedFrame(depthai.Buffer)

Kind: Class

#### depthai.EncodedFrame.FrameType

Kind: Class

Members:

I

P

B

Unknown

##### B: typing.ClassVar[RawEncodedFrame.FrameType]

Kind: Class Variable

##### I: typing.ClassVar[RawEncodedFrame.FrameType]

Kind: Class Variable

##### P: typing.ClassVar[RawEncodedFrame.FrameType]

Kind: Class Variable

##### Unknown: typing.ClassVar[RawEncodedFrame.FrameType]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawEncodedFrame.FrameType]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawEncodedFrame.FrameType) -> int: int

Kind: Method

##### __init__(self: RawEncodedFrame.FrameType, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawEncodedFrame.FrameType) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawEncodedFrame.FrameType, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### depthai.EncodedFrame.Profile

Kind: Class

Members:

JPEG

AVC

HEVC

##### AVC: typing.ClassVar[RawEncodedFrame.Profile]

Kind: Class Variable

##### HEVC: typing.ClassVar[RawEncodedFrame.Profile]

Kind: Class Variable

##### JPEG: typing.ClassVar[RawEncodedFrame.Profile]

Kind: Class Variable

##### __members__: typing.ClassVar[dict[str, RawEncodedFrame.Profile]]

Kind: Class Variable

##### __eq__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __getstate__(self) -> int: int

Kind: Method

##### __hash__(self) -> int: int

Kind: Method

##### __index__(self: RawEncodedFrame.Profile) -> int: int

Kind: Method

##### __init__(self: RawEncodedFrame.Profile, value: typing.SupportsInt)

Kind: Method

##### __int__(self: RawEncodedFrame.Profile) -> int: int

Kind: Method

##### __ne__(self, other: typing.Any) -> bool: bool

Kind: Method

##### __repr__(self) -> str: str

Kind: Method

##### __setstate__(self: RawEncodedFrame.Profile, state: typing.SupportsInt)

Kind: Method

##### __str__(self) -> str: str

Kind: Method

##### name

Kind: Property

##### value

Kind: Property

#### __init__(self)

Kind: Method

#### getBitrate(self) -> int: int

Kind: Method

Retrieves the encoding bitrate

#### getColorTemperature(self) -> int: int

Kind: Method

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

#### getExposureTime(self) -> datetime.timedelta: datetime.timedelta

Kind: Method

Retrieves exposure time

#### getFrameType(self) -> RawEncodedFrame.FrameType: RawEncodedFrame.FrameType

Kind: Method

Retrieves frame type (H26x only)

#### getHeight(self) -> int: int

Kind: Method

Retrieves image height in pixels

#### getInstanceNum(self) -> int: int

Kind: Method

Retrieves instance number

#### getLensPosition(self) -> int: int

Kind: Method

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

#### getLensPositionRaw(self) -> float: float

Kind: Method

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

#### getLossless(self) -> bool: bool

Kind: Method

Returns true if encoding is lossless (JPEG only)

#### getProfile(self) -> RawEncodedFrame.Profile: RawEncodedFrame.Profile

Kind: Method

Retrieves the encoding profile (JPEG, AVC or HEVC)

#### getQuality(self) -> int: int

Kind: Method

Retrieves the encoding quality

#### getSensitivity(self) -> int: int

Kind: Method

Retrieves sensitivity, as an ISO value

#### getSequenceNum(self) -> int: int

Kind: Method

Retrieves sequence number

#### getTimestamp(self) -> datetime.timedelta: datetime.timedelta

Kind: Method

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

#### getTimestampDevice(self) -> datetime.timedelta: datetime.timedelta

Kind: Method

Retrieves timestamp directly captured from device's monotonic clock, not
synchronized to host time. Used mostly for debugging

#### getWidth(self) -> int: int

Kind: Method

Retrieves image width in pixels

#### setBitrate(self, arg0: typing.SupportsInt) -> EncodedFrame: EncodedFrame

Kind: Method

Retrieves the encoding bitrate

#### setFrameType(self, arg0: RawEncodedFrame.FrameType) -> EncodedFrame: EncodedFrame

Kind: Method

Retrieves frame type (H26x only)

#### setHeight(self, arg0: typing.SupportsInt) -> EncodedFrame: EncodedFrame

Kind: Method

Specifies frame height

Parameter ``height``:
frame height

#### setLossless(self, arg0: bool) -> EncodedFrame: EncodedFrame

Kind: Method

Returns true if encoding is lossless (JPEG only)

#### setProfile(self, arg0: RawEncodedFrame.Profile) -> EncodedFrame: EncodedFrame

Kind: Method

Retrieves the encoding profile (JPEG, AVC or HEVC)

#### setQuality(self, arg0: typing.SupportsInt) -> EncodedFrame: EncodedFrame

Kind: Method

Retrieves the encoding quality

#### setSequenceNum(self, arg0: typing.SupportsInt) -> EncodedFrame: EncodedFrame

Kind: Method

Specifies sequence number

Parameter ``seq``:
Sequence number

#### setTimestamp(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrame

Kind: Method

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

#### setTimestampDevice(self, arg0: datetime.timedelta) -> EncodedFrame: EncodedFrame

Kind: Method

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

#### setWidth(self, arg0: typing.SupportsInt) -> EncodedFrame: EncodedFrame

Kind: Method

Specifies frame width

Parameter ``width``:
frame width

### Need assistance?

Head over to [Discussion Forum](https://discuss.luxonis.com/) for technical support or any other questions you might have.