webcface.member module
- class webcface.member.Member(base: Field, member: str = '')[source]
Bases:
Field- canvas2d(field: str, width: SupportsFloat | None = None, height: SupportsFloat | None = None) Canvas2D[source]
Canvas2Dオブジェクトを生成
- Parameters:
height (width,) – Canvas2Dのサイズを指定して初期化する
- func(arg: str = '', **kwargs) Func[source]
Funcオブジェクトを生成
- member.func(arg: str)
指定した名前のFuncオブジェクトを生成・参照する。
- @member.func(arg: str, [**kwargs])
デコレータとして使い、デコレートした関数を指定した名前でセットする。
デコレート後、関数は元のまま返す。
- @member.func([**kwargs])
3と同じだが、名前はデコレートした関数から自動で取得される。
- member.func(arg: Callable, [**kwargs])
これはver2.0で削除。
2, 3 の場合のkwargsは Func.set() を参照。
- func_listener(field: str) FuncListener[source]
FuncListenerオブジェクトを生成 (ver2.2〜)
- property lib_name: str
このMemberが使っているWebCFaceライブラリの識別情報
c++クライアントライブラリは”cpp”, javascriptクライアントは”js”, pythonクライアントは”python”を返す。
- property lib_version: str
このMemberが使っているWebCFaceのバージョン
- log(field: str = 'default') Log[source]
Logオブジェクトを生成
- Parameters:
field – (ver2.1〜) Logの名前を指定可能(省略すると”default”)
- property name: str
Member名
- on_canvas2d_entry(func: Callable) Callable[source]
Canvas2Dが追加されたときのイベント
コールバックの引数にはCanvas2Dオブジェクトが渡される。
- on_canvas3d_entry(func: Callable) Callable[source]
Canvas3Dが追加されたときのイベント
コールバックの引数にはCanvas3Dオブジェクトが渡される。
- on_ping(func: Callable) Callable[source]
通信速度データが更新されたときのイベント
通信速度データをリクエストしていなければリクエストする
コールバックの引数にはMemberオブジェクトが渡される。
- property ping_status: int | None
通信速度を調べる
通信速度データをリクエストしていなければリクエストし、 sync()後通信速度が得られるようになる :return: データがなければ None, 受信していれば pingの往復時間 (ms)
- property remote_addr: str
このMemberのIPアドレス
- property sync_time: datetime
memberが最後にsyncした時刻を返す