webcface.image module

class webcface.image.Image(base: Field, field: str = '')

Bases: Field

child(field: str) → Image

子フィールドを返す

Returns:

「(thisのフィールド名).(子フィールド名)」をフィールド名とするImage

exists() → bool

このフィールドにデータが存在すればtrue

try_get() などとは違って、実際のデータを受信しない。 リクエストもしない。

get() → ImageFrame

画像を返す、まだリクエストされてなければ自動でリクエストされる

property member: Member

Memberを返す

property name: str

field名を返す

on_change(func: Callable) → Callable

値が変化したときのイベント

コールバックの引数にはImageオブジェクトが渡される。

まだ値をリクエストされてなければ自動でリクエストされる

request(width: int | None = None, height: int | None = None, color_mode: int | None = None, compress_mode: int | None = None, quality: int | None = None, frame_rate: int | None = None) → None

画像の受信をリクエストする

Parameters:

• width – 画像の幅

• height – 画像の高さ width, height のどちらかのみがNoneの場合縦横比を保ってリサイズし、 どちらもNoneの場合は元画像のサイズになる

• color_mode – 画像の色フォーマット (Noneの場合元画像のフォーマット)

• cmp_mode – 圧縮モード

• quality – 圧縮のパラメータ * jpeg → 0〜100 (大きいほうが高品質) * png → 0〜9 (大きいほうが圧縮後のサイズが小さい) * webp → 1〜100 (大きいほうが高品質)

• frame_rate – 画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

set(data: ImageFrame) → Image

画像をセットする

try_get() → ImageFrame | None

画像を返す、まだリクエストされてなければ自動でリクエストされる