webcface.member module

class webcface.member.Member(base: Field, member: str = '')[source]

Bases: Field

funcs() Iterable[Func][source]

このメンバーのFuncをすべて取得する。

Deprecated since version 1.1.

property lib_name: str

このMemberが使っているWebCFaceライブラリの識別情報

c++クライアントライブラリは”cpp”, javascriptクライアントは”js”, pythonクライアントは”python”を返す。

property lib_version: str

このMemberが使っているWebCFaceのバージョン

property name: str

Member名

on_canvas2d_entry(func: Callable) Callable[source]

Canvas2Dが追加されたときのイベント

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

on_canvas3d_entry(func: Callable) Callable[source]

Canvas3Dが追加されたときのイベント

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

on_func_entry(func: Callable) Callable[source]

Funcが追加されたときのイベント

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

on_image_entry(func: Callable) Callable[source]

Textが追加されたときのイベント

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

on_log_entry(func: Callable) Callable[source]

Logが追加されたときのイベント(ver2.1〜)

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

on_ping(func: Callable) Callable[source]

通信速度データが更新されたときのイベント

通信速度データをリクエストしていなければリクエストする

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

on_sync(func: Callable) Callable[source]

Memberがsyncしたときのイベント

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

on_text_entry(func: Callable) Callable[source]

Textが追加されたときのイベント

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

on_value_entry(func: Callable) Callable[source]

Valueが追加されたときのイベント

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

on_view_entry(func: Callable) Callable[source]

Viewが追加されたときのイベント

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

property ping_status: int | None

通信速度を調べる

通信速度データをリクエストしていなければリクエストし、 sync()後通信速度が得られるようになる :return: データがなければ None, 受信していれば pingの往復時間 (ms)

property remote_addr: str

このMemberのIPアドレス

request_ping_status() None[source]

通信速度データをリクエストする (ver2.0〜)

property sync_time: datetime

memberが最後にsyncした時刻を返す

texts() Iterable[Text][source]

このメンバーのTextをすべて取得する。

Deprecated since version 1.1.

values() Iterable[Value][source]

このメンバーのValueをすべて取得する。

Deprecated since version 1.1.

views() Iterable[View][source]

このメンバーのViewをすべて取得する。

Deprecated since version 1.1.