ClientEventMap
ClientEventMap =
object
Defined in: src/types/events.ts:167
Properties
Section titled “Properties”accessControl
Section titled “accessControl”accessControl:
EventHandler<WebcastAccessControlMessage>
Defined in: src/types/events.ts:226
accessRecall
Section titled “accessRecall”accessRecall:
EventHandler<WebcastAccessRecallMessage>
Defined in: src/types/events.ts:227
barrage
Section titled “barrage”barrage:
EventHandler<WebcastBarrageMessage>
Defined in: src/types/events.ts:201
boostCard
Section titled “boostCard”boostCard:
EventHandler<WebcastBoostCardMessage>
Defined in: src/types/events.ts:228
bottomMessage
Section titled “bottomMessage”bottomMessage:
EventHandler<WebcastBottomMessage>
Defined in: src/types/events.ts:229
capsule
Section titled “capsule”capsule:
EventHandler<WebcastCapsuleMessage>
Defined in: src/types/events.ts:230
captionMessage
Section titled “captionMessage”captionMessage:
EventHandler<WebcastCaptionMessage>
Defined in: src/types/events.ts:207
chat:
EventHandler<WebcastChatMessage>
Defined in: src/types/events.ts:188
connected
Section titled “connected”connected:
EventHandler<TikTokLiveConnectionState>
Defined in: src/types/events.ts:178
controlMessage
Section titled “controlMessage”controlMessage:
EventHandler<WebcastControlMessage>
Defined in: src/types/events.ts:200
decodedData
Section titled “decodedData”decodedData: (
type,event,binary) =>void|Promise<void>
Defined in: src/types/events.ts:183
Parameters
Section titled “Parameters”string
any
binary
Section titled “binary”Uint8Array
Returns
Section titled “Returns”void | Promise<void>
disconnected
Section titled “disconnected”disconnected:
EventHandler<{code:number;reason?:string; }>
Defined in: src/types/events.ts:179
emote:
EventHandler<WebcastEmoteChatMessage>
Defined in: src/types/events.ts:198
enterRoom
Section titled “enterRoom”enterRoom:
EventHandler<DecodedWebcastPushFrame>
Defined in: src/types/events.ts:185
envelope
Section titled “envelope”envelope:
EventHandler<WebcastEnvelopeMessage>
Defined in: src/types/events.ts:199
error:
EventHandler<any>
Defined in: src/types/events.ts:180
follow
Section titled “follow”follow:
EventHandler<WebcastSocialMessage>
Defined in: src/types/events.ts:170
gameRankNotify
Section titled “gameRankNotify”gameRankNotify:
EventHandler<WebcastGameRankNotifyMessage>
Defined in: src/types/events.ts:231
gift:
EventHandler<WebcastGiftMessage>
Defined in: src/types/events.ts:190
giftBroadcast
Section titled “giftBroadcast”giftBroadcast:
EventHandler<WebcastGiftBroadcastMessage>
Defined in: src/types/events.ts:232
giftDynamicRestriction
Section titled “giftDynamicRestriction”giftDynamicRestriction:
EventHandler<WebcastGiftDynamicRestrictionMessage>
Defined in: src/types/events.ts:233
giftPanelUpdate
Section titled “giftPanelUpdate”giftPanelUpdate:
EventHandler<WebcastGiftPanelUpdateMessage>
Defined in: src/types/events.ts:234
giftPrompt
Section titled “giftPrompt”giftPrompt:
EventHandler<WebcastGiftPromptMessage>
Defined in: src/types/events.ts:235
goalUpdate
Section titled “goalUpdate”goalUpdate:
EventHandler<WebcastGoalUpdateMessage>
Defined in: src/types/events.ts:205
guide:
EventHandler<WebcastGuideMessage>
Defined in: src/types/events.ts:236
hourlyRank
Section titled “hourlyRank”hourlyRank:
EventHandler<WebcastHourlyRankRewardMessage>
Defined in: src/types/events.ts:237
imDelete
Section titled “imDelete”imDelete:
EventHandler<WebcastImDeleteMessage>
Defined in: src/types/events.ts:208
inRoomBanner
Section titled “inRoomBanner”inRoomBanner:
EventHandler<WebcastInRoomBannerMessage>
Defined in: src/types/events.ts:209
like:
EventHandler<WebcastLikeMessage>
Defined in: src/types/events.ts:193
linkLayer
Section titled “linkLayer”linkLayer:
EventHandler<WebcastLinkLayerMessage>
Defined in: src/types/events.ts:222
linkMessage
Section titled “linkMessage”linkMessage:
EventHandler<WebcastLinkMessage>
Defined in: src/types/events.ts:221
linkMicArmies
Section titled “linkMicArmies”linkMicArmies:
EventHandler<WebcastLinkMicArmies>
Defined in: src/types/events.ts:196
linkMicBattle
Section titled “linkMicBattle”linkMicBattle:
EventHandler<WebcastLinkMicBattle>
Defined in: src/types/events.ts:195
linkMicBattleItemCard
Section titled “linkMicBattleItemCard”linkMicBattleItemCard:
EventHandler<WebcastLinkMicBattleItemCard>
Defined in: src/types/events.ts:213
linkMicBattlePunishFinish
Section titled “linkMicBattlePunishFinish”linkMicBattlePunishFinish:
EventHandler<WebcastLinkMicBattlePunishFinish>
Defined in: src/types/events.ts:214
linkMicBattleTask
Section titled “linkMicBattleTask”linkMicBattleTask:
EventHandler<WebcastLinkmicBattleTaskMessage>
Defined in: src/types/events.ts:215
linkMicFanTicketMethod
Section titled “linkMicFanTicketMethod”linkMicFanTicketMethod:
EventHandler<WebcastLinkMicFanTicketMethod>
Defined in: src/types/events.ts:216
linkMicLayoutState
Section titled “linkMicLayoutState”linkMicLayoutState:
EventHandler<WebcastLinkMicLayoutStateMessage>
Defined in: src/types/events.ts:238
linkMicMethod
Section titled “linkMicMethod”linkMicMethod:
EventHandler<WebcastLinkMicMethod>
Defined in: src/types/events.ts:217
linkState
Section titled “linkState”linkState:
EventHandler<WebcastLinkStateMessage>
Defined in: src/types/events.ts:239
liveGameIntro
Section titled “liveGameIntro”liveGameIntro:
EventHandler<WebcastLiveGameIntroMessage>
Defined in: src/types/events.ts:240
liveIntro
Section titled “liveIntro”liveIntro:
EventHandler<WebcastLiveIntroMessage>
Defined in: src/types/events.ts:197
marqueeAnnouncement
Section titled “marqueeAnnouncement”marqueeAnnouncement:
EventHandler<WebcastMarqueeAnnouncementMessage>
Defined in: src/types/events.ts:241
member
Section titled “member”member:
EventHandler<WebcastMemberMessage>
Defined in: src/types/events.ts:189
msgDetect
Section titled “msgDetect”msgDetect:
EventHandler<WebcastMsgDetectMessage>
Defined in: src/types/events.ts:220
notice
Section titled “notice”notice:
EventHandler<WebcastNoticeMessage>
Defined in: src/types/events.ts:242
oecLiveShopping
Section titled “oecLiveShopping”oecLiveShopping:
EventHandler<WebcastOecLiveShoppingMessage>
Defined in: src/types/events.ts:219
partnershipDropsUpdate
Section titled “partnershipDropsUpdate”partnershipDropsUpdate:
EventHandler<WebcastPartnershipDropsUpdateMessage>
Defined in: src/types/events.ts:243
partnershipGameOffline
Section titled “partnershipGameOffline”partnershipGameOffline:
EventHandler<WebcastPartnershipGameOfflineMessage>
Defined in: src/types/events.ts:244
partnershipPunish
Section titled “partnershipPunish”partnershipPunish:
EventHandler<WebcastPartnershipPunishMessage>
Defined in: src/types/events.ts:245
perception
Section titled “perception”perception:
EventHandler<WebcastPerceptionMessage>
Defined in: src/types/events.ts:246
pollMessage
Section titled “pollMessage”pollMessage:
EventHandler<WebcastPollMessage>
Defined in: src/types/events.ts:211
questionNew
Section titled “questionNew”questionNew:
EventHandler<WebcastQuestionNewMessage>
Defined in: src/types/events.ts:194
rankText
Section titled “rankText”rankText:
EventHandler<WebcastRankTextMessage>
Defined in: src/types/events.ts:212
rankUpdate
Section titled “rankUpdate”rankUpdate:
EventHandler<WebcastRankUpdateMessage>
Defined in: src/types/events.ts:210
rawData
Section titled “rawData”rawData: (
type,data) =>void|Promise<void>
Defined in: src/types/events.ts:182
Parameters
Section titled “Parameters”string
Uint8Array
Returns
Section titled “Returns”void | Promise<void>
roomMessage
Section titled “roomMessage”roomMessage:
EventHandler<WebcastRoomMessage>
Defined in: src/types/events.ts:206
roomNotify
Section titled “roomNotify”roomNotify:
EventHandler<WebcastRoomNotifyMessage>
Defined in: src/types/events.ts:247
roomPin
Section titled “roomPin”roomPin:
EventHandler<WebcastRoomPinMessage>
Defined in: src/types/events.ts:223
roomUser
Section titled “roomUser”roomUser:
EventHandler<WebcastRoomUserSeqMessage>
Defined in: src/types/events.ts:191
roomVerify
Section titled “roomVerify”roomVerify:
EventHandler<WebcastRoomVerifyMessage>
Defined in: src/types/events.ts:248
share:
EventHandler<WebcastSocialMessage>
Defined in: src/types/events.ts:174
social
Section titled “social”social:
EventHandler<WebcastSocialMessage>
Defined in: src/types/events.ts:192
speaker
Section titled “speaker”speaker:
EventHandler<WebcastSpeakerMessage>
Defined in: src/types/events.ts:249
streamEnd
Section titled “streamEnd”streamEnd: (
event) =>void|Promise<void>
Defined in: src/types/events.ts:175
Parameters
Section titled “Parameters”action
Section titled “action”ControlAction
Returns
Section titled “Returns”void | Promise<void>
subNotify
Section titled “subNotify”subNotify:
EventHandler<WebcastSubNotifyMessage>
Defined in: src/types/events.ts:250
subPinEvent
Section titled “subPinEvent”subPinEvent:
EventHandler<WebcastSubPinEventMessage>
Defined in: src/types/events.ts:251
superFan
Section titled “superFan”superFan:
EventHandler<WebcastBarrageMessage>
Defined in: src/types/events.ts:171
superFanBox
Section titled “superFanBox”superFanBox:
EventHandler<WebcastEnvelopeMessage>
Defined in: src/types/events.ts:173
superFanJoin
Section titled “superFanJoin”superFanJoin:
EventHandler<WebcastBarrageMessage>
Defined in: src/types/events.ts:172
system
Section titled “system”system:
EventHandler<WebcastSystemMessage>
Defined in: src/types/events.ts:204
toast:
EventHandler<WebcastToastMessage>
Defined in: src/types/events.ts:252
unauthorizedMember
Section titled “unauthorizedMember”unauthorizedMember:
EventHandler<WebcastUnauthorizedMemberMessage>
Defined in: src/types/events.ts:218
viewerPicksUpdate
Section titled “viewerPicksUpdate”viewerPicksUpdate:
EventHandler<WebcastViewerPicksUpdateMessage>
Defined in: src/types/events.ts:253
websocketConnected
Section titled “websocketConnected”websocketConnected:
EventHandler<WebcastWebSocketClient>
Defined in: src/types/events.ts:184
websocketData
Section titled “websocketData”websocketData:
EventHandler<Uint8Array>
Defined in: src/types/events.ts:181