WebcastWSClient

Websocket client responsible for connections to TikTok

Signature

class WebcastWSClient

WebcastWSClient(
    ws_kwargs: Optional[dict] = None,
    ws_proxy: Optional[WebcastProxy] = None,
)

Initialize WebcastWSClient

ws_kwargs (Optional[dict], default None) — Overrides for the websocket connection
ws_proxy (Optional[WebcastProxy], default None)

DEFAULT_PING_INTERVAL (float) = 5.0
ws (property, Optional[WebSocketClientProtocol]) — Get the current WebSocketClientProtocol
connected (property, bool) — Check if the WebSocket is open

send() — Send a message to the WebSocket
send_ack() — Acknowledge the receipt of a ProtoMessageFetchResult message from TikTok, if necessary
disconnect() — Request to stop the websocket connection & wait
get_ws_cookie_string() — Get the cookie string for the WebSocket connection.
connect() — Connect to the Webcast server & iterate over response messages.
restart_ping_loop() — Restart the WebSocket ping loop
switch_rooms()

from TikTokLive.client.ws.ws_client import WebcastWSClient