extract_webcast_response_message

Extract the ProtoMessageFetchResult from a push frame. If compression is enabled on the WebSocket, then messages will come gzipped. This method will decompress the payload if necessary. The gzip format allows for less bandwidth usage, at the cost of a slight CPU increase for message decompression.

Signature

def extract_webcast_response_message(
    push_frame: WebcastPushFrame,
    logger: logging.Logger = TikTokLiveLogHandler.get_logger(),
) -> ProtoMessageFetchResult

Parameters

• push_frame (WebcastPushFrame) — Push frame to extract from
• logger (logging.Logger, default TikTokLiveLogHandler.get_logger()) — Logger to use for logging

Returns

ProtoMessageFetchResult — ProtoMessageFetchResult The extracted response

Import

from TikTokLive.client.ws.ws_utils import extract_webcast_response_message

Source

TikTokLive/client/ws/ws_utils.py:76