tiktok-live-connector/dist/types/events.d.ts

Node.js library to receive live stream chat events like comments and gifts from TikTok LIVE.

import { ControlAction, WebcastChatMessage, WebcastControlMessage, WebcastEmoteChatMessage, WebcastEnvelopeMessage, WebcastGiftMessage, WebcastLikeMessage, WebcastLinkMicArmies, WebcastLinkMicBattle, WebcastLiveIntroMessage, WebcastMemberMessage, WebcastQuestionNewMessage, WebcastRoomUserSeqMessage, WebcastSocialMessage, WebcastSubNotifyMessage } from '../types/tiktok-schema';
import { DecodedWebcastPushFrame, RoomGiftInfo, RoomInfo, WebcastEventMessage, WebcastMessage } from '../types/client';
import TikTokWsClient from '../lib/ws/lib/ws-client';
export declare enum ControlEvent {
    CONNECTED = "connected",
    DISCONNECTED = "disconnected",
    ERROR = "error",
    RAW_DATA = "rawData",
    DECODED_DATA = "decodedData",
    WEBSOCKET_CONNECTED = "websocketConnected",
    WEBSOCKET_DATA = "websocketData",
    ENTER_ROOM = "enterRoom"
}
export declare enum WebcastEvent {
    CHAT = "chat",
    MEMBER = "member",
    GIFT = "gift",
    ROOM_USER = "roomUser",
    SOCIAL = "social",
    LIKE = "like",
    QUESTION_NEW = "questionNew",
    LINK_MIC_BATTLE = "linkMicBattle",
    LINK_MIC_ARMIES = "linkMicArmies",
    LIVE_INTRO = "liveIntro",
    EMOTE = "emote",
    ENVELOPE = "envelope",
    SUBSCRIBE = "subscribe",
    FOLLOW = "follow",
    SHARE = "share",
    STREAM_END = "streamEnd",
    CONTROL_MESSAGE = "controlMessage",
    BARRAGE = "barrage",
    HOURLY_RANK = "hourlyRank",
    GOAL_UPDATE = "goalUpdate",
    ROOM_MESSAGE = "roomMessage",
    CAPTION_MESSAGE = "captionMessage",
    IM_DELETE = "imDelete",
    IN_ROOM_BANNER = "inRoomBanner",
    RANK_UPDATE = "rankUpdate",
    POLL_MESSAGE = "pollMessage",
    RANK_TEXT = "rankText",
    LINK_MIC_BATTLE_PUNISH_FINISH = "linkMicBattlePunishFinish",
    LINK_MIC_BATTLE_TASK = "linkMicBattleTask",
    LINK_MIC_FAN_TICKET_METHOD = "linkMicFanTicketMethod",
    LINK_MIC_METHOD = "linkMicMethod",
    UNAUTHORIZED_MEMBER = "unauthorizedMember",
    OEC_LIVE_SHOPPING = "oecLiveShopping",
    MSG_DETECT = "msgDetect",
    LINK_MESSAGE = "linkMessage",
    ROOM_VERIFY = "roomVerify",
    LINK_LAYER = "linkLayer",
    ROOM_PIN = "roomPin"
}
export declare enum ConnectState {
    DISCONNECTED = "DISCONNECTED",
    CONNECTING = "CONNECTING",
    CONNECTED = "CONNECTED"
}
export type EventHandler<T> = (event: T) => void | Promise<void>;
export type ClientEventMap = {
    [WebcastEvent.FOLLOW]: EventHandler<WebcastSocialMessage>;
    [WebcastEvent.SHARE]: EventHandler<WebcastSocialMessage>;
    [WebcastEvent.STREAM_END]: (event: {
        action: ControlAction;
    }) => void | Promise<void>;
    [ControlEvent.CONNECTED]: EventHandler<TikTokLiveConnectionState>;
    [ControlEvent.DISCONNECTED]: EventHandler<void>;
    [ControlEvent.ERROR]: EventHandler<any>;
    [ControlEvent.WEBSOCKET_DATA]: EventHandler<Uint8Array>;
    [ControlEvent.RAW_DATA]: (type: string, data: Uint8Array) => void | Promise<void>;
    [ControlEvent.DECODED_DATA]: (type: string, event: any, binary: Uint8Array) => void | Promise<void>;
    [ControlEvent.WEBSOCKET_CONNECTED]: EventHandler<TikTokWsClient>;
    [ControlEvent.ENTER_ROOM]: EventHandler<DecodedWebcastPushFrame>;
    [WebcastEvent.CHAT]: EventHandler<WebcastChatMessage>;
    [WebcastEvent.MEMBER]: EventHandler<WebcastMemberMessage>;
    [WebcastEvent.GIFT]: EventHandler<WebcastGiftMessage>;
    [WebcastEvent.ROOM_USER]: EventHandler<WebcastRoomUserSeqMessage>;
    [WebcastEvent.SOCIAL]: EventHandler<WebcastSocialMessage>;
    [WebcastEvent.LIKE]: EventHandler<WebcastLikeMessage>;
    [WebcastEvent.QUESTION_NEW]: EventHandler<WebcastQuestionNewMessage>;
    [WebcastEvent.LINK_MIC_BATTLE]: EventHandler<WebcastLinkMicBattle>;
    [WebcastEvent.LINK_MIC_ARMIES]: EventHandler<WebcastLinkMicArmies>;
    [WebcastEvent.LIVE_INTRO]: EventHandler<WebcastLiveIntroMessage>;
    [WebcastEvent.EMOTE]: EventHandler<WebcastEmoteChatMessage>;
    [WebcastEvent.ENVELOPE]: EventHandler<WebcastEnvelopeMessage>;
    [WebcastEvent.SUBSCRIBE]: EventHandler<WebcastSubNotifyMessage>;
    [WebcastEvent.CONTROL_MESSAGE]: EventHandler<WebcastControlMessage>;
    [WebcastEvent.BARRAGE]: EventHandler<WebcastMessage>;
    [WebcastEvent.HOURLY_RANK]: EventHandler<WebcastMessage>;
    [WebcastEvent.GOAL_UPDATE]: EventHandler<WebcastMessage>;
    [WebcastEvent.ROOM_MESSAGE]: EventHandler<WebcastMessage>;
    [WebcastEvent.CAPTION_MESSAGE]: EventHandler<WebcastMessage>;
    [WebcastEvent.IM_DELETE]: EventHandler<WebcastMessage>;
    [WebcastEvent.IN_ROOM_BANNER]: EventHandler<WebcastMessage>;
    [WebcastEvent.RANK_UPDATE]: EventHandler<WebcastMessage>;
    [WebcastEvent.POLL_MESSAGE]: EventHandler<WebcastMessage>;
    [WebcastEvent.RANK_TEXT]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_MIC_BATTLE_PUNISH_FINISH]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_MIC_BATTLE_TASK]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_MIC_FAN_TICKET_METHOD]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_MIC_METHOD]: EventHandler<WebcastMessage>;
    [WebcastEvent.UNAUTHORIZED_MEMBER]: EventHandler<WebcastMessage>;
    [WebcastEvent.OEC_LIVE_SHOPPING]: EventHandler<WebcastMessage>;
    [WebcastEvent.MSG_DETECT]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_MESSAGE]: EventHandler<WebcastMessage>;
    [WebcastEvent.ROOM_VERIFY]: EventHandler<WebcastMessage>;
    [WebcastEvent.LINK_LAYER]: EventHandler<WebcastMessage>;
    [WebcastEvent.ROOM_PIN]: EventHandler<WebcastMessage>;
};
export declare const WebcastEventMap: Record<BasicWebcastEventMessage, keyof ClientEventMap>;
export type BasicWebcastEventMessage = keyof Omit<WebcastEventMessage, 'WebcastGiftMessage'>;
export type TikTokLiveConnectionState = {
    isConnected: boolean;
    roomId: string;
    roomInfo: RoomInfo | null;
    availableGifts: RoomGiftInfo | null;
};
//# sourceMappingURL=events.d.ts.map