webcface.image_frame module

class webcface.image_frame.ImageColorMode(value)

Bases: IntEnum

An enumeration.

BGR = 1

BGRA = 2

GRAY = 0

RGB = 3

RGBA = 4

class webcface.image_frame.ImageCompressMode(value)

Bases: IntEnum

An enumeration.

JPEG = 1

PNG = 3

RAW = 0

WEBP = 2

class webcface.image_frame.ImageFrame(width: int, height: int, data: bytes, color_mode: int, compress_mode: int)

Bases: object

画像データ (ver2.4〜)

• 8bitのグレースケール, BGR, BGRAフォーマットのみを扱う

• 画像受信時にはjpegやpngなどにエンコードされたデータが入ることもある

property channels: int

1ピクセルあたりのデータサイズ(byte数)

property color_mode: int

色の並び順

compress_modeがRAWでない場合意味をなさない。

ImageColorMode のenumを参照

property compress_mode: int

画像の圧縮モード

ImageCompressMode のenumを参照

property data: bytes

画像データ

compress_modeがRAWの場合、height * width * channels 要素の画像データ。 それ以外の場合、圧縮された画像のデータ

empty() → bool

画像が空かどうかを返す

static from_numpy(img: ndarray, color_mode: int) → ImageFrame

numpy配列からImageFrameを作成する

color_mode がGRAYの場合 (height, width) または (height, width, 1), color_mode がBGR,RGBの場合 (height, width, 3), color_mode がBGRA,RGBAの場合 (height, width, 4) のuint8配列のみが使用可能

property height: int

画像の高さ

numpy() → ndarray

numpy配列に変換する

color_mode がGRAYの場合 (height, width, 1), color_mode がBGR,RGBの場合 (height, width, 3), color_mode がBGRA,RGBAの場合 (height, width, 4) のuint8配列を返す

compress_mode がRAWでない場合はエラー

property width: int

画像の幅

class webcface.image_frame.ImageReq(width, height, color_mode, compress_mode, quality, frame_rate)

Bases: object

color_mode: int | None

compress_mode: int | None

frame_rate: float | None

height: int | None

quality: int | None

width: int | None