Context¶

ContextOptions `dataclass` ¶

ContextOptions(log_level: int = DEBUG, member: LocalMemberConfig = LocalMemberConfig())

SkyWayContext のセットアップ時に指定するオプション。

log_level: int = logging.DEBUG

SDK が出力するログのレベル。デフォルトは logging.DEBUG。

member: LocalMemberConfig = field(default_factory=LocalMemberConfig)

LocalRoomMember の keepalive に関する設定。

SkyWayContext()

SkyWay Python SDK 全体の設定を行うコンテキスト。

version = __version__

SkyWay Python SDK のバージョン。

is_setup = False

SkyWayContext がセットアップ済みの場合 True、そうでない場合 False。

setup(token: str, options: ContextOptions | None = None) -> None

SkyWayContext をセットアップし、SkyWayの操作を利用可能にする。

create_room(name: str | None = None, metadata: str | None = None) -> Room

新しい Room を作成する。

find_room(id: str, name: None) -> Room

find_room(id: None, name: str) -> Room

find_room(id: str, name: str) -> Room

find_room(id: str | None = None, name: str | None = None) -> Room

IDまたはNameからRoomを検索して取得する。

find_or_create_room(name: str, metadata: str | None = None) -> Room

NameでRoomを検索し、存在しなければ作成してRoomを返す。

dispose() -> None

SkyWayContext を破棄し、使用していたリソースを解放する。