connect

Method of TikTokLiveClient.

Start a future-blocking connection to TikTokLive.

Kwargs are spelled out (not **kwargs) so IDE autocomplete and mypy can verify call sites. Every option is forwarded to start.

Signature

async def connect(
    callback: Optional[Union[Callable[[None], None], Callable[[None], Coroutine[None, None, None]], Coroutine[None, None, None]]] = None,
    *,
    process_connect_events: bool = True,
    compress_ws_events: bool = True,
    fetch_room_info: bool = False,
    fetch_gift_info: bool = False,
    fetch_live_check: bool = True,
    room_id: Optional[int] = None,
) -> Task

Parameters

• callback (Optional[Union[Callable[[None], None], Callable[[None], Coroutine[None, None, None]], Coroutine[None, None, None]]], default None) — A callback function to run when connected
• process_connect_events (bool, default True) — Whether to process initial events sent on room join
• compress_ws_events (bool, default True) — Whether to compress WebSocket events using gzip
• fetch_room_info (bool, default False) — Whether to fetch room info on join
• fetch_gift_info (bool, default False) — Whether to fetch gift info on join
• fetch_live_check (bool, default True) — Whether to check if the user is live
• room_id (Optional[int], default None) — Optional override to skip room scraping

Returns

Task — The task, once it’s finished

Import

from TikTokLive import TikTokLiveClient

Source

TikTokLive/client/client.py:220