kittycad.api.modeling.modeling_commands_ws

Functions

asyncio(fps, unlocked_framerate, ...)	Pass those commands to the engine via websocket, and pass responses back to the client.
sync(fps, unlocked_framerate, ...)	Pass those commands to the engine via websocket, and pass responses back to the client.

Classes

WebSocket(fps, unlocked_framerate, ...)

A websocket connection to the API endpoint.

class kittycad.api.modeling.modeling_commands_ws.WebSocket(fps, unlocked_framerate, video_res_height, video_res_width, webrtc, client)

A websocket connection to the API endpoint.

__annotations__ = {'ws': <class 'websockets.sync.client.ClientConnection'>}

__dict__ = mappingproxy({'__module__': 'kittycad.api.modeling.modeling_commands_ws', '__annotations__': {'ws': <class 'websockets.sync.client.ClientConnection'>}, '__doc__': 'A websocket connection to the API endpoint.', '__init__': <function WebSocket.__init__>, '__enter__': <function WebSocket.__enter__>, '__exit__': <function WebSocket.__exit__>, '__iter__': <function WebSocket.__iter__>, 'send': <function WebSocket.send>, 'send_binary': <function WebSocket.send_binary>, 'recv': <function WebSocket.recv>, 'close': <function WebSocket.close>, '__dict__': <attribute '__dict__' of 'WebSocket' objects>, '__weakref__': <attribute '__weakref__' of 'WebSocket' objects>})

__enter__()

__exit__(exc_type, exc_value, traceback)

__init__(fps, unlocked_framerate, video_res_height, video_res_width, webrtc, client)

__iter__()

Iterate on incoming messages.

The iterator calls recv() and yields messages in an infinite loop.

It exits when the connection is closed normally. It raises a ConnectionClosedError exception after a protocol error or a network failure.

Return type:

Iterator[RootModel[Union[SuccessWebSocketResponse, FailureWebSocketResponse]]]

__module__ = 'kittycad.api.modeling.modeling_commands_ws'

close()

Close the websocket.

recv()

Receive data from the websocket.

Return type:

RootModel[Union[SuccessWebSocketResponse, FailureWebSocketResponse]]

send(data)

Send data to the websocket.

send_binary(data)

Send data as bson to the websocket.

ws: ClientConnection

kittycad.api.modeling.modeling_commands_ws._get_kwargs(fps, unlocked_framerate, video_res_height, video_res_width, webrtc, *, client)

Return type:

Dict[str, Any]

async kittycad.api.modeling.modeling_commands_ws.asyncio(fps, unlocked_framerate, video_res_height, video_res_width, webrtc, *, client)

Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.

Return type:

WebSocketClientProtocol

kittycad.api.modeling.modeling_commands_ws.sync(fps, unlocked_framerate, video_res_height, video_res_width, webrtc, *, client)

Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.

Return type:

ClientConnection