nanover.websocket.client.app_client module

class nanover.websocket.client.app_client.FramePublisherShim(client: NanoverImdClient): Bases: FramePublisher

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

Bases: InteractionClient, SelectionClient, PlaybackClient, CommandClient, StateClient, AppServerMinimal

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 has_minimum_usable_frame: True if the current frame contains basic topology and particle positions.

property latest_multiplayer_values

publish_frame(frame: FrameData, *, frame_index=None): Publish a frame to the server, replacing the frame_index if provided.

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_minimum_usable_frame(check_interval=0.01, timeout=1)

Wait until the client has basic topology information and particle positions.

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 current FrameData containing basic topology and positions.

Raises:

Exception – if no frame is received.

nanover.websocket.client.app_client.get_websocket_address_from_app_server(app_server: AppServer): Retrieve the advertised address for connecting to a server over insecure websocket (ws) protocol.

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