custom_events

Classes

• WebsocketResponseEvent — Triggered when any event is received from the WebSocket. Carries the raw ProtoMessageFetchResult envelope this event was extracted from on self.raw for callers that want to inspect the underlying response fields (cursor, fetch_interval, ws_params, etc.).
• UnknownEvent — Triggered when a Webcast message is received that is NOT tracked by TikTokLive yet.
• SuperFanEvent — Emitted when a viewer becomes a super fan of the streamer.
• SuperFanJoinEvent — Emitted when an existing super fan joins the live (distinct from SuperFanEvent which fires when a viewer first becomes a super fan).
• SuperFanBoxEvent — Emitted when a super-fan envelope (gift box) is delivered.
• ConnectEvent — Manually thrown when the first payload is received from the Sign Server
• DisconnectEvent — Thrown when disconnecting from a stream
• LiveEndEvent — Thrown when the stream ends
• LivePauseEvent — Thrown when the stream is paused
• LiveUnpauseEvent — Thrown when a paused stream is unpaused
• FollowEvent — A SocialEvent, but we give it its own class for clarity’s sake.
• ShareEvent — A SocialEvent, but we give it its own class for clarity’s sake.

Attributes

• CustomEvent (TypeAlias)

Import

import TikTokLive.events.custom_events

Source

TikTokLive/events/custom_events.py