nanover.websocket.client.app_client module

class nanover.websocket.client.app_client.NanoverImdClient(*args, **kwargs)

Bases: InteractionClient, SelectionClient, PlaybackClient

Mixin of methods for selection manipulation with a WebSocketClient.

copy_state()

property current_frame: FrameData

property frames: list[FrameData]

classmethod from_app_server(app_server: AppServer)

classmethod from_discovery(*, server_name: str | None = None, discovery_port: int | None = None)

classmethod from_runner(runner: Any)

get_shared_value(key: str, default=None)

property latest_multiplayer_values

recv_frame(message: dict)

remove_shared_value(key: str)

set_shared_value(key: str, value)

update_available_commands()

wait_until_first_frame(check_interval=0.01, timeout=1)

Wait until the first frame is received from the server.

Parameters:

check_interval – Interval at which to check if a frame has been received.
timeout – Timeout after which to stop waiting for a frame.

Returns:

The first FrameData received.

Raises:

Exception – if no frame is received.

nanover.websocket.client.app_client.get_websocket_address_from_app_server(app_server: AppServer)

nanover.websocket.client.app_client.get_websocket_address_from_hub(hub: ServiceHub, *, host: str | None = None)