@ycryptx/tiktok-live-connector/dist/proto/tiktokSchema.d.ts

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

export function encodeWebcastResponse(message: any): any;
export function decodeWebcastResponse(binary: any): {
    messages: any[];
    cursor: string;
    fetchInterval: number;
    serverTimestamp: {
        low: number;
        high: number;
        unsigned: any;
    };
    internalExt: string;
    fetchType: number;
    wsParam: {
        name: string;
        value: string;
    };
    heartbeatDuration: number;
    needAck: boolean;
    wsUrl: string;
};
export function encodeMessage(message: any): any;
export function decodeMessage(binary: any): {
    type: string;
    binary: any;
};
export function encodeWebsocketParam(message: any): any;
export function decodeWebsocketParam(binary: any): {
    name: string;
    value: string;
};
export function encodeWebcastControlMessage(message: any): any;
export function decodeWebcastControlMessage(binary: any): {
    action: number;
};
export function encodeWebcastRoomUserSeqMessage(message: any): any;
export function decodeWebcastRoomUserSeqMessage(binary: any): {
    topViewers: any[];
    viewerCount: number;
};
export function encodeTopUser(message: any): any;
export function decodeTopUser(binary: any): {
    coinCount: {
        low: number;
        high: number;
        unsigned: any;
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
};
export function encodeWebcastChatMessage(message: any): any;
export function decodeWebcastChatMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    comment: string;
    emotes: any[];
};
export function encodeWebcastEmoteChatMessage(message: any): any;
export function decodeWebcastEmoteChatMessage(binary: any): {
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    emote: {
        emoteId: string;
        image: {
            imageUrl: string;
        };
    };
};
export function encodeWebcastSubEmote(message: any): any;
export function decodeWebcastSubEmote(binary: any): {
    placeInComment: number;
    emote: {
        emoteId: string;
        image: {
            imageUrl: string;
        };
    };
};
export function encodeWebcastMemberMessage(message: any): any;
export function decodeWebcastMemberMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    actionId: number;
};
export function encodeWebcastGiftMessage(message: any): any;
export function decodeWebcastGiftMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    giftId: number;
    repeatCount: number;
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    repeatEnd: number;
    groupId: {
        low: number;
        high: number;
        unsigned: any;
    };
    giftDetails: {
        giftImage: {
            giftPictureUrl: string;
        };
        giftName: string;
        describe: string;
        giftType: number;
        diamondCount: number;
    };
    monitorExtra: string;
    giftExtra: {
        timestamp: {
            low: number;
            high: number;
            unsigned: any;
        };
        receiverUserId: {
            low: number;
            high: number;
            unsigned: any;
        };
    };
};
export function encodeWebcastGiftMessageGiftDetails(message: any): any;
export function decodeWebcastGiftMessageGiftDetails(binary: any): {
    giftImage: {
        giftPictureUrl: string;
    };
    giftName: string;
    describe: string;
    giftType: number;
    diamondCount: number;
};
export function encodeWebcastGiftMessageGiftExtra(message: any): any;
export function decodeWebcastGiftMessageGiftExtra(binary: any): {
    timestamp: {
        low: number;
        high: number;
        unsigned: any;
    };
    receiverUserId: {
        low: number;
        high: number;
        unsigned: any;
    };
};
export function encodeWebcastGiftMessageGiftImage(message: any): any;
export function decodeWebcastGiftMessageGiftImage(binary: any): {
    giftPictureUrl: string;
};
export function encodeWebcastLinkMicBattle(message: any): any;
export function decodeWebcastLinkMicBattle(binary: any): {
    battleUsers: any[];
};
export function encodeWebcastLinkMicBattleItems(message: any): any;
export function decodeWebcastLinkMicBattleItems(binary: any): {
    battleGroup: {
        user: {
            userId: {
                low: number;
                high: number;
                unsigned: any;
            };
            nickname: string;
            profilePicture: {
                urls: any[];
            };
            uniqueId: string;
        };
    };
};
export function encodeWebcastLinkMicBattleGroup(message: any): any;
export function decodeWebcastLinkMicBattleGroup(binary: any): {
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
    };
};
export function encodeWebcastLinkMicArmies(message: any): any;
export function decodeWebcastLinkMicArmies(binary: any): {
    battleItems: any[];
    battleStatus: number;
};
export function encodeWebcastLinkMicArmiesItems(message: any): any;
export function decodeWebcastLinkMicArmiesItems(binary: any): {
    hostUserId: {
        low: number;
        high: number;
        unsigned: any;
    };
    battleGroups: any[];
};
export function encodeWebcastLinkMicArmiesGroup(message: any): any;
export function decodeWebcastLinkMicArmiesGroup(binary: any): {
    users: any[];
    points: number;
};
export function encodeWebcastSocialMessage(message: any): any;
export function decodeWebcastSocialMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
};
export function encodeWebcastLikeMessage(message: any): any;
export function decodeWebcastLikeMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    likeCount: number;
    totalLikeCount: number;
};
export function encodeWebcastQuestionNewMessage(message: any): any;
export function decodeWebcastQuestionNewMessage(binary: any): {
    questionDetails: {
        questionText: string;
        user: {
            userId: {
                low: number;
                high: number;
                unsigned: any;
            };
            nickname: string;
            profilePicture: {
                urls: any[];
            };
            uniqueId: string;
            secUid: string;
            badges: any[];
            createTime: {
                low: number;
                high: number;
                unsigned: any;
            };
            bioDescription: string;
            followInfo: {
                followingCount: number;
                followerCount: number;
                followStatus: number;
                pushStatus: number;
            };
        };
    };
};
export function encodeQuestionDetails(message: any): any;
export function decodeQuestionDetails(binary: any): {
    questionText: string;
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
};
export function encodeWebcastMessageEvent(message: any): any;
export function decodeWebcastMessageEvent(binary: any): {
    msgId: {
        low: number;
        high: number;
        unsigned: any;
    };
    createTime: {
        low: number;
        high: number;
        unsigned: any;
    };
    eventDetails: {
        displayType: string;
        label: string;
    };
};
export function encodeWebcastMessageEventDetails(message: any): any;
export function decodeWebcastMessageEventDetails(binary: any): {
    displayType: string;
    label: string;
};
export function encodeWebcastLiveIntroMessage(message: any): any;
export function decodeWebcastLiveIntroMessage(binary: any): {
    id: {
        low: number;
        high: number;
        unsigned: any;
    };
    description: string;
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
};
export function encodeSystemMessage(message: any): any;
export function decodeSystemMessage(binary: any): {
    description: string;
};
export function encodeWebcastInRoomBannerMessage(message: any): any;
export function decodeWebcastInRoomBannerMessage(binary: any): {
    data: string;
};
export function encodeRankItem(message: any): any;
export function decodeRankItem(binary: any): {
    colour: string;
    id: {
        low: number;
        high: number;
        unsigned: any;
    };
};
export function encodeWeeklyRanking(message: any): any;
export function decodeWeeklyRanking(binary: any): {
    type: string;
    label: string;
    rank: {
        colour: string;
        id: {
            low: number;
            high: number;
            unsigned: any;
        };
    };
};
export function encodeRankContainer(message: any): any;
export function decodeRankContainer(binary: any): {
    rankings: {
        type: string;
        label: string;
        rank: {
            colour: string;
            id: {
                low: number;
                high: number;
                unsigned: any;
            };
        };
    };
};
export function encodeWebcastHourlyRankMessage(message: any): any;
export function decodeWebcastHourlyRankMessage(binary: any): {
    data: {
        rankings: {
            type: string;
            label: string;
            rank: {
                colour: string;
                id: {
                    low: number;
                    high: number;
                    unsigned: any;
                };
            };
        };
    };
};
export function encodeEmoteDetails(message: any): any;
export function decodeEmoteDetails(binary: any): {
    emoteId: string;
    image: {
        imageUrl: string;
    };
};
export function encodeEmoteImage(message: any): any;
export function decodeEmoteImage(binary: any): {
    imageUrl: string;
};
export function encodeWebcastEnvelopeMessage(message: any): any;
export function decodeWebcastEnvelopeMessage(binary: any): {
    treasureBoxData: {
        coins: number;
        canOpen: number;
        timestamp: {
            low: number;
            high: number;
            unsigned: any;
        };
    };
    treasureBoxUser: {
        user2: {
            user3: any[];
        };
    };
};
export function encodeTreasureBoxUser(message: any): any;
export function decodeTreasureBoxUser(binary: any): {
    user2: {
        user3: any[];
    };
};
export function encodeTreasureBoxUser2(message: any): any;
export function decodeTreasureBoxUser2(binary: any): {
    user3: any[];
};
export function encodeTreasureBoxUser3(message: any): any;
export function decodeTreasureBoxUser3(binary: any): {
    user4: {
        user: {
            userId: {
                low: number;
                high: number;
                unsigned: any;
            };
            nickname: string;
            profilePicture: {
                urls: any[];
            };
            uniqueId: string;
            secUid: string;
            badges: any[];
            createTime: {
                low: number;
                high: number;
                unsigned: any;
            };
            bioDescription: string;
            followInfo: {
                followingCount: number;
                followerCount: number;
                followStatus: number;
                pushStatus: number;
            };
        };
    };
};
export function encodeTreasureBoxUser4(message: any): any;
export function decodeTreasureBoxUser4(binary: any): {
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
};
export function encodeTreasureBoxData(message: any): any;
export function decodeTreasureBoxData(binary: any): {
    coins: number;
    canOpen: number;
    timestamp: {
        low: number;
        high: number;
        unsigned: any;
    };
};
export function encodeWebcastSubNotifyMessage(message: any): any;
export function decodeWebcastSubNotifyMessage(binary: any): {
    event: {
        msgId: {
            low: number;
            high: number;
            unsigned: any;
        };
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        eventDetails: {
            displayType: string;
            label: string;
        };
    };
    user: {
        userId: {
            low: number;
            high: number;
            unsigned: any;
        };
        nickname: string;
        profilePicture: {
            urls: any[];
        };
        uniqueId: string;
        secUid: string;
        badges: any[];
        createTime: {
            low: number;
            high: number;
            unsigned: any;
        };
        bioDescription: string;
        followInfo: {
            followingCount: number;
            followerCount: number;
            followStatus: number;
            pushStatus: number;
        };
    };
    exhibitionType: number;
    subMonth: number;
    subscribeType: number;
    oldSubscribeStatus: number;
    subscribingStatus: number;
};
export function encodeUser(message: any): any;
export function decodeUser(binary: any): {
    userId: {
        low: number;
        high: number;
        unsigned: any;
    };
    nickname: string;
    profilePicture: {
        urls: any[];
    };
    uniqueId: string;
    secUid: string;
    badges: any[];
    createTime: {
        low: number;
        high: number;
        unsigned: any;
    };
    bioDescription: string;
    followInfo: {
        followingCount: number;
        followerCount: number;
        followStatus: number;
        pushStatus: number;
    };
};
export function encodeFollowInfo(message: any): any;
export function decodeFollowInfo(binary: any): {
    followingCount: number;
    followerCount: number;
    followStatus: number;
    pushStatus: number;
};
export function encodeLinkUser(message: any): any;
export function decodeLinkUser(binary: any): {
    userId: {
        low: number;
        high: number;
        unsigned: any;
    };
    nickname: string;
    profilePicture: {
        urls: any[];
    };
    uniqueId: string;
};
export function encodeProfilePicture(message: any): any;
export function decodeProfilePicture(binary: any): {
    urls: any[];
};
export function encodeUserBadgesAttributes(message: any): any;
export function decodeUserBadgesAttributes(binary: any): {
    badgeSceneType: number;
    imageBadges: any[];
    badges: any[];
    privilegeLogExtra: {
        privilegeId: string;
        level: string;
    };
};
export function encodePrivilegeLogExtra(message: any): any;
export function decodePrivilegeLogExtra(binary: any): {
    privilegeId: string;
    level: string;
};
export function encodeUserBadge(message: any): any;
export function decodeUserBadge(binary: any): {
    type: string;
    name: string;
};
export function encodeUserImageBadge(message: any): any;
export function decodeUserImageBadge(binary: any): {
    displayType: number;
    image: {
        url: string;
    };
};
export function encodeUserImageBadgeImage(message: any): any;
export function decodeUserImageBadgeImage(binary: any): {
    url: string;
};
export function encodeWebcastWebsocketMessage(message: any): any;
export function decodeWebcastWebsocketMessage(binary: any): {
    id: {
        low: number;
        high: number;
        unsigned: any;
    };
    type: string;
    binary: any;
};
export function encodeWebcastWebsocketAck(message: any): any;
export function decodeWebcastWebsocketAck(binary: any): {
    id: {
        low: number;
        high: number;
        unsigned: any;
    };
    type: string;
};
//# sourceMappingURL=tiktokSchema.d.ts.map