{"_id":"@adamjessop/tiktok-live-connector","name":"@adamjessop/tiktok-live-connector","dist-tags":{"latest":"2.0.1"},"versions":{"2.0.1":{"name":"@adamjessop/tiktok-live-connector","version":"2.0.1","description":"Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE","main":"./dist/index.js","types":"./dist/index.d.ts","engines":{"node":">=10.0.0"},"scripts":{"build":"npx tsx update-version.ts && npm run build:copy-package && npx tsc && npx tsc-alias","build:copy-package":"cpx package.json dist && cpx LICENSE dist"},"repository":{"type":"git","url":"git+https://github.com/zerodytrash/TikTok-Live-Connector.git"},"funding":["https://buymeacoffee.com/isaackogan","https://buymeacoffee.com/zerody"],"keywords":["tiktok","tiktok live","tiktok.com","live","stream","livestream","chat","connector","api","webcast","tracker","scraper","websocket","bot","broadcast","reader"],"author":{"name":"zerodytrash"},"license":"MIT","bugs":{"url":"https://github.com/zerodytrash/TikTok-Live-Connector/issues"},"homepage":"https://github.com/zerodytrash/TikTok-Live-Connector#readme","dependencies":{"@bufbuild/protobuf":"^2.2.5","@eulerstream/euler-api-sdk":"^0.0.4","axios":"^1.9.0","callable-instance":"^2.0.0","protobufjs":"^6.11.2","websocket":"^1.0.35"},"devDependencies":{"@babel/cli":"^7.17.0","@babel/core":"^7.17.2","@babel/preset-env":"^7.16.11","@types/node":"^22.15.3","@types/websocket":"^1.0.10","@types/ws":"^8.18.1","cpx":"^1.5.0","dotenv":"^16.5.0","prettier":"2.5.1","ts-proto":"^2.6.1","tsc-alias":"^1.8.15","typed-emitter":"^2.1.0","typescript":"^4.8.2"},"_id":"@adamjessop/tiktok-live-connector@2.0.1","gitHead":"045d68b289ec4ab18939bb6eed3e19f819c17b2e","_nodeVersion":"22.4.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-Bo+wJyHixkXMh1otANVIKonUPqtPjTRHNOOVaLeZatnA1gB0RTOvLpllhpFQndWEvA6GGIgfkdzxlcCpfaDktQ==","shasum":"868b7108fc0cf4082cee2d18317525294c042246","tarball":"https://registry.npmjs.org/@adamjessop/tiktok-live-connector/-/tiktok-live-connector-2.0.1.tgz","fileCount":125,"unpackedSize":873790,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCCrrYcvd+XHletxsO5qTrTLA5qNbLNvIdSOWpIr2geoAIhAIxCqDA4l8aeIlZGCUZOWBP6hkprhkWkiaOfHRBZdTWk"}]},"_npmUser":{"name":"adamjessop","email":"me@adamjessop.net"},"directories":{},"maintainers":[{"name":"adamjessop","email":"me@adamjessop.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/tiktok-live-connector_2.0.1_1746633566508_0.16017449595569433"},"_hasShrinkwrap":false}},"time":{"created":"2025-05-07T15:59:26.422Z","2.0.1":"2025-05-07T15:59:26.753Z","modified":"2025-05-07T15:59:26.977Z"},"maintainers":[{"name":"adamjessop","email":"me@adamjessop.net"}],"description":"Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE","homepage":"https://github.com/zerodytrash/TikTok-Live-Connector#readme","keywords":["tiktok","tiktok live","tiktok.com","live","stream","livestream","chat","connector","api","webcast","tracker","scraper","websocket","bot","broadcast","reader"],"repository":{"type":"git","url":"git+https://github.com/zerodytrash/TikTok-Live-Connector.git"},"author":{"name":"zerodytrash"},"bugs":{"url":"https://github.com/zerodytrash/TikTok-Live-Connector/issues"},"license":"MIT","readme":"# TikTok-Live-Connector\n\nA Node.js library to receive live stream events such as comments and gifts in realtime\nfrom [TikTok LIVE](https://www.tiktok.com/live) by connecting to TikTok's internal Webcast push service.\nThis package includes a wrapper that connects to the Webcast service using just the username (`@uniqueId`).\nThis allows you to connect to your own live chat as well as the live chat of other streamers. No credentials are\nrequired. Besides [Chat Comments](#chat), other events such\nas [Members Joining](#member), [Gifts](#gift), [Subscriptions](#subscribe), [Viewers](#roomuser), [Follows](#social), [Shares](#social), [Questions](#questionnew), [Likes](#like)\nand [Battles](#linkmicbattle) can be tracked.\n\n\n\n\n\n\n\n> [!NOTE]\n> This is not an official API. It is a reverse engineering project. You are responsible for your usage of this library.\n\n> [!TIP]\n> An example project is available\n> at https://tiktok-chat-reader.zerody.one/ - [View Source](https://github.com/zerodytrash/TikTok-Chat-Reader)\n\n> [!WARNING]\n> This JavaScript library is intended for use in [Node.js](https://nodejs.org/) environments. If you want to process or\n> display the data in the browser (client-side), you need to transfer the data from the Node.js environment to the\n> browser. A good approach for this is to use [Socket.IO](https://socket.io/) or a different low-latency communication\n> framework. A complete example project can be found\n> here: [TikTok-Chat-Reader](https://github.com/zerodytrash/TikTok-Chat-Reader)\n\n> [!WARNING]\n> Due to a change on the part of TikTok, versions prior **v1.1.7** are no longer functional. If you are using one of\n> these versions, upgrade to the latest version using the `npm i tiktok-live-connector` command.\n\n### 📌 2.0.0 Now Available - Upgrade Now!\n\nWe are thrilled to announce that the 2.0.0 release of TikTok Live Connector is now available!\nThis release converts the package to exclusively typescript-based, also providing complete backwards compatibility for users.\n\n#### Upgrade Guide\n\n- Install via `npm i tiktok-live-connector@2.0.0`\n- Switch `WebcastPushConnection` to `TikTokLiveConnection` (or keep for legacy support)\n- Switch Event Names to `WebcastEvent.EVENT_NAME` from `event_name` format\n- That's it! You're good to go!\n- If you have any issues, please open an issue on GitHub or ask on [Discord](https://discord.gg/2c6kX6g3Pa).\n\n#### Breaking Changes\n\n- The `sendMessage` function has been removed (for now)\n- `WebcastPushConnection` has been renamed to `TikTokLiveConnection`\n- CommonJS support has been removed\n- Data fetching functions have been renamed\n\n### Do you prefer other programming languages?\n\n- **Python** rewrite: [TikTokLive](https://github.com/isaackogan/TikTokLive)\n by [@isaackogan](https://github.com/isaackogan) and [@eulerstream](https://github.com/eulerstream/)\n- **Java** rewrite: [TikTokLiveJava](https://github.com/jwdeveloper/TikTokLiveJava)\n by [@jwdeveloper](https://github.com/jwdeveloper) and [@kohlerpop1](https://github.com/kohlerpop1)\n- **Go** rewrite: [GoTikTokLive](https://github.com/steampoweredtaco/gotiktoklive)\n by [@steampoweredtaco](https://github.com/steampoweredtaco) and [@davincible](https://github.com/davincible)\n- **C#** rewrite: [TikTokLiveSharp](https://github.com/frankvHoof93/TikTokLiveSharp)\n by [@frankvHoof93](https://github.com/frankvHoof93)\n\n### Table of Contents\n\n- [Getting Started](#getting-started)\n- [Params and Options](#params-and-options)\n- [Methods](#methods)\n- [Properties](#properties)\n- [Events](#events)\n- [Examples](#examples)\n- [Contributing](#contributing)\n\n## Getting Started\n\n1. Install the package via NPM\n\n```bash\nnpm i tiktok-live-connector\n```\n\n2. Create your first TikTok LIVE chat connection\n\n```ts\n// Username of someone who is currently live\nimport { TikTokLiveConnection, WebcastEvent } from 'tiktok-live-connector';\n\nconst tiktokUsername = 'officialgeilegisela';\n\n// Create a new wrapper object and pass the username\nconst connection = new TikTokLiveConnection(tiktokUsername);\n\n// Connect to the chat (await can be used as well)\nconnection.connect().then(state => {\n console.info(`Connected to roomId ${state.roomId}`);\n}).catch(err => {\n console.error('Failed to connect', err);\n});\n\n// Define the events that you want to handle\n// In this case we listen to chat messages (comments)\nconnection.on(WebcastEvent.CHAT, data => {\n console.log(`${data.user.uniqueId} (userId:${data.user.uniqueId}) writes: ${data.comment}`);\n});\n\n// And here we receive gifts sent to the streamer\nconnection.on(WebcastEvent.GIFT, data => {\n console.log(`${data.user.uniqueId} (userId:${data.user.userId}) sends ${data.giftId}`);\n});\n\n// ...and more events described in the documentation below\n```\n\n## Params and Options\n\nTo create a new `TikTokLiveConnection` object the following parameters can be specified.\n\n`TikTokLiveConnection(uniqueId, [options])`\n\n| Param Name | Required | Description |\n|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| uniqueId | Yes | The unique username of the broadcaster. You can find this name in the URL. Example: `https://www.tiktok.com/@officialgeilegisela/live` => `officialgeilegisela` |\n| options | No | Here you can set the following optional connection properties. If you do not specify a value, the default value will be used.
`processInitialData` (default: `true`) Define if you want to process the initital data which includes old messages of the last seconds.
`fetchRoomInfoOnConnect` (default: `true`) Define if you want to fetch all room information on [`connect()`](#methods). If this option is enabled, the connection to offline rooms will be prevented. If enabled, the connect result contains the room info via the `roomInfo` attribute. You can also manually retrieve the room info (even in an unconnected state) using the [`getRoomInfo()`](#methods) function.
`enableExtendedGiftInfo` (default: `false`) Define if you want to receive extended information about gifts like gift name, cost and images. This information will be provided at the [gift event](#gift).
`requestPollingIntervalMs` (default: `1000`) Request polling interval if WebSocket is not used.
`sessionId` (default: `null`) Here you can specify the current Session ID of your TikTok account
`webClientParams` (default: `{}`) Custom client params for Webcast API.
`webClientHeaders` (default: `{}`) Custom request headers passed to [axios](https://github.com/axios/axios).
`websocketHeaders` (default: `{}`) Custom websocket headers passed to [websocket.client](https://github.com/theturtle32/WebSocket-Node).
`webClientOptions` (default: `{}`) Custom request options passed to [axios](https://github.com/axios/axios). Here you can specify an `httpsAgent` to use a proxy and a `timeout` value. See [Example](#proxied-connection).
`wsClientParams` (default: `${}`) WebSocket parameters to be appended to the connection url.
`wsClientHeaders` (default: {}) Custom WebSocket headers to be sent when connecting.
`wsClientOptions` (default: `{}`) Custom websocket options passed to [websocket.client](https://github.com/theturtle32/WebSocket-Node). Here you can specify an `agent` to use a proxy and a `timeout` value. See [Example](#proxied-connection).
`authenticateWs` (default: `false`) By default, WebSocket connections are not authenticated, even when passing a sessionid, for security. This is because 'signing' (generating the URL) for connecting is done by a 3rd-party freeware service. It must be manually enabled, and you assume the risks associated with sending over a session id when you enable it.
`preferredAgentIds` (default: `[]`) WebSocket URL generation is done by a 3rd-party service. This option allows you to specify a specific 'agent' on the 3rd-party service to handle the URL generation.
`connectWithUniqueId` (default: `false`) This option allows the 3rd-party service to determine the Room ID _for_ you, rather than retrieving it through scraping. This may be preferable on low-quality IPs, as it bypasses captchas.
`logFetchFallbackErrors` (default: false) This option logs exceptions to the console when fallbacks are required to resolve a Room Id from a uniqueId.
`signedWebSocketProvider` (default: `(props: FetchSignedWebSocketParams) => Promise`) The function responsible for signing (generating a valid WebSocket URL) can be swapped out for your own backend, if you do not want to use the free 3rd-party service bundled into the client that generates them. |\n\n#### Example Options\n\n```ts\nconst tikTokLiveConnection = new TikTokLiveConnection(tiktokUsername, {\n processInitialData: false,\n enableExtendedGiftInfo: true,\n requestPollingIntervalMs: 2000,\n webClientParams: {\n \"app_language\": \"en-US\",\n \"device_platform\": \"web\"\n },\n webClientHeaders: {\n \"headerName\": \"headerValue\"\n },\n wsClientHeaders: {\n \"headerName\": \"headerValue\"\n },\n wsClientParams: {\n \"app_language\": \"en-US\",\n },\n webClientOptions: {\n timeout: 10000\n },\n wsClientOptions: {\n timeout: 10000\n }\n});\n```\n\n## Methods\n\n| Method Name | Description |\n|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| connect(`[roomId]`) | Connects to the live stream chat. Returns a `Promise` which will be resolved when the connection is successfully established. Optionally, you can provide a Room Id to bypass Room Id scraping. |\n| disconnect() | Disconnects from the stream if connected. |\n| fetchRoomId(`[uniqueId]`) | Fetch the Room Id associated with the currently configured `uniqueId`. Optionally, provide a `uniqueId` for a different user to check. Returns a `Promise` which is resolved when the Room Id is fetched. |\n| fetchIsLive() | Fetch whether the user is currently streaming. Returns a `Promise` which resolves when the state is fetched. |\n| waitUntilLive() | Returns a blocking promise that resolves when the user goes live. |\n| fetchRoomInfo() | Gets the current room info from TikTok API including streamer info, room status and statistics. Returns a `Promise` which will be resolved when the API request is done. *Note: You can call this function even if you're not connected.* [Example](#retrieve-room-info) |\n| fetchAvailableGifts() | Gets a list of all available gifts including gift name, image url, diamont cost and a lot of other information. Returns a `Promise` that will be resolved when all available gifts has been retrieved from the API. *Note: You can call this function even if you're not connected.* [Example](#retrieve-available-gifts) |\n\n## Properties\n\n| Property Name | Description |\n|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| webClient: `TikTokWebClient` | An API wrapper for TikTok with routes for scraping the TikTok site & internal APIs. This is used to fetch the initial data and room info. |\n| wsClient: `TikTokWsClient \\| null` | The WebSocket client object. This manages the lifecycle of the WebSocket connection to TikTok, and is where all events originate from. |\n| options: `TikTokLiveConnectionOptions` | Options described in [Params and Options](#params-and-options) |\n| roomInfo: `RoomInfoResponse` | The room info object. This contains all information about the current room. |\n| availableGifts: `RoomGiftInfo` | The list of available gifts. This is only filled if `enableExtendedGiftInfo` is set to `true`. |\n| isConnecting: `boolean` | Indicates whether the connection is currently being established. |\n| isConnected: `boolean` | Indicates whether the connection is currently established. |\n| webClientParams: `Record` | Base URI parameters that are sent with every request of `TikTokWebClient`. |\n| roomId: `string` | The current room id. This is only available after a successful connection. |\n| state: `TikTokLiveConnectionState` | The current state of the connection. Includes info such as connection status, Room Id, room info, etc. |\n\n## Signing Configuration\n\nIt is possible to configure the [3rd-party library](https://github.com/EulerStream/EulerApiSdk) used to generate\nWebSocket URLs, a process referred to as 'signing'. An example is provided below:\n\n```ts\n// SignConfig is an instance of Partial\nimport { SignConfig } from 'tiktok-live-connector';\n\nSignConfig.apiKey = \"your api key\" // An API key created at https://www.eulerstream.com\nSignConfig.basePath = \"https://your-custom-sign-server.com\" // Optionally, you can even define your own server\nSignConfig.baseOptions.headers['X-Custom-Header'] = 'Custom-Header-Value'\n```\n\n## Accessing TikTok LIVE Routes\n\nThe `TikTokWebClient` object is used to access TikTok's internal API routes. This object is available via\nthe `webClient` property of the `TikTokLiveConnection` object.\n\nThe following routes come bundled with the web client:\n\n- `connection.webClient.fetchRoomInfo`\n- `connection.webClient.sendRoomChat`\n- `connection.webClient.fetchRoomInfoFromApiLive`\n- `connection.webClient.fetchRoomInfoFromHtml`\n- `connection.webClient.fetchSignedWebSocketFromEuler`\n- `connection.webClient.fetchRoomIdFromEuler`\n- `connection.webClient.fetchRoomInfoFromEuler`\n\n### Example Usage:\n\nAll routes are callable classes that accepts a singular object with the required parameters, and return a promise\nthat resolves with the route data. For instance, here is how you can fetch Room Info from the page HTML:\n\n```ts\nconst connection = new TikTokLiveConnection('officialgeilegisela');\n\nconnection.webClient.fetchRoomInfoFromHtml({ uniqueId: uniqueId })\n .then((response: FetchRoomInfoFromHtmlRouteResponse) => {\n console.log('Room Info:', response.data);\n });\n```\n\n## Accessing 3rd-Party Routes\n\nThe `TikTokWebClient` comes bundled with an instance of `EulerSigner`, a 3rd-party library that provides the WebSocket\nconnection URL used to\nconnect to TikTok LIVE.\n\nThis is publicly accessible via `connection.webClient.webSigner` and exposes additional 3rd-party routes related to\nTikTok LIVE.\n\n### Example 1: Fetching Rate Limits\n\nFor example, here's how you can fetch the rate limits for your current API key:\n\n```ts\nimport { SignConfig } from 'tiktok-live-connector';\nimport { IGetRateLimits } from '@eulerstream/euler-api-sdk';\n\n// Configure an API Key\nSignConfig.apiKey = 'your api key'; // An API key created at https://www.eulerstream.com\n\n// Create a connection\nconst connection = new TikTokLiveConnection();\n\n// Fetch the limits\nconnection.webClient.webSigner.webcast.getRateLimits()\n .then((response: AxiosResponse) => {\n console.log('Rate Limits:', response.data);\n });\n```\n\n### Example 2: Using JWT Authentication\n\nIf you intend to run the TikTok-Live-Connector in a client environment (e.g. a bundled desktop app), you won't want to\ngive the user your API key. Instead, you can create a JWT for the user to connect to the API.\n\n### Server-Side:\n\nFirst, generate the JWT and return it to your user:\n\n```ts\nimport { SignConfig, TikTokWebClient } from './src';\n\nSignConfig.apiKey = 'your_api_key_here';\nconst connection = new TikTokWebClient();\n\nconnection.webSigner.authentication.createJWT(\n 122, // Your account ID\n {\n limits: {\n minute: 5,\n day: 5,\n hour: 5\n },\n expireAfter: 60 * 60 * 2 // 2 hours is the max accepted value\n }\n).then((res) => {\n console.log('Generated JWT:', res.data.token);\n});\n```\n\n### Client-Side:\n\nThen, use the JWT to connect to the API in the client-side NodeJS application:\n\n```ts\nimport { SignConfig } from './config';\nimport { TikTokLiveConnection } from './client';\n\nSignConfig.baseOptions.headers['x-jwt-key'] = 'generated-jwt-key';\nconst connection = new TikTokLiveConnection('tv_asahi_news');\n```\n\n## Events\n\nA `TikTokLiveConnection` object has the following events which can be handled with an event listener.\n\nThe simplest event handler is a connect event:\n\n```ts\nconst connection = new TikTokLiveConnection('officialgeilegisela');\nconnection.on(ControlEvent.CONNECTED, () => console.log(\"Connected!\"));\n```\n\n### Control Events:\n\n- [`ControleEvent.CONNECTED`](#connected) or `\"connected\"`\n- [`ControleEvent.DISCONNECTED`](#disconnected) or `\"disconnected\"`\n- [`ControleEvent.STREAM_END`](#streamend) or `\"streamEnd\"`\n- [`ControleEvent.RAW_DATA`](#rawdata) or `\"rawData\"`\n- [`ControleEvent.DECODED_DATA`](#decodeddata) or `\"decodedData\"`\n- [`ControleEvent.WEBSOCKET_CONNECTED`](#websocketconnected) or `\"websocketConnected\"`\n- [`ControleEvent.ERROR`](#error) or `\"error\"`\n\n### Message Events:\n\n- [`WebcastEvent.CHAT`](#chat) or `\"chat\"`\n- [`WebcastEvent.GIFT`](#gift) or `\"gift\"`\n- [`WebcastEvent.MEMBER`](#member) or `\"member\"`\n- [`WebcastEvent.LIKE`](#like) or `\"like\"`\n- [`WebcastEvent.SOCIAL`](#social) or `\"social\"`\n- [`WebcastEvent.ENVELOPE`](#envelope) or `\"envelope\"`\n- [`WebcastEvent.QUESTION_NEW`](#questionnew) or `\"questionNew\"`\n- [`WebcastEvent.LINK_MIC_BATTLE`](#linkmicbattle) or `\"linkMicBattle\"`\n- [`WebcastEvent.LINK_MIC_ARMIES`](#linkmicarmies) or `\"linkMicArmies\"`\n- [`WebcastEvent.LIVE_INTRO`](#liveintro) or `\"liveIntro\"`\n- [`WebcastEvent.SUBSCRIBE`](#subscribe) or `\"subscribe\"`\n- [`WebcastEvent.FOLLOW`](#follow) or `\"follow\"`\n- [`WebcastEvent.SHARE`](#share) or `\"share\"`\n- [`WebcastEvent.STREAM_END`](#streamend) or `\"streamEnd\"`\n- [`WebcastEvent.ROOM_USER`](#roomuser) or `\"roomUser\"`\n- [`WebcastEvent.EMOTE`](#emote) or `\"emote\"`\n- [`WebcastEvent.FOLLOW`](#follow) or `\"follow\"`\n- [`WebcastEvent.SHARE`](#share) or `\"share\"`\n\n## Control Events\n\n### `connected`\n\nTriggered when the connection is successfully established.\n\n```ts\nclient.on(\n WebcastEvent.CONNECTED,\n (state: TikTokLiveConnectionState) => console.log('Hurray! Connected!', state)\n);\n```\n\n⚡ See Data Structure
\n\n### `disconnected`\n\nTriggered when the connection gets disconnected. In that case you can call `connect()` again to have a reconnect logic.\nNote that you should wait a little bit before attempting a reconnect to to avoid being rate-limited.\n\n```ts\nconnection.on(ControlEvent.DISCONNECTED, () => console.log('Disconnected :('));\n```\n\n### `streamEnd`\n\nTriggered when the live stream gets terminated by the host. Will also trigger the [`disconnected`](#disconnected) event.\n\n```ts\nconnection.on(ControlEvent.STREAM_END, ({ action }: { action: ControlAction }) => {\n if (action === ControlAction.CONTROL_ACTION_STREAM_ENDED) {\n console.log('Stream ended by user');\n }\n if (action === ControlAction.CONTROL_ACTION_STREAM_SUSPENDED) {\n console.log('Stream ended by platform moderator (ban)');\n }\n});\n```\n\n### `rawData`\n\nTriggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the\nuse case with protobufjs.\n\n```ts\nconnection.on(ControlEvent.RAW_DATA, (messageTypeName, binary) => {\n console.log(messageTypeName, binary);\n});\n```\n\n### `decodedData`\n\nTriggered every time a decoded message arrives. This is the same as the `rawData` event but the binary object is already\ndecoded. You can use this event to handle the protobuf messages without the need of deserializing them yourself.\n\n```ts\nconnection.on(ControlEvent.DECODED_DATA, (event: string, decodedData: any, binary: Uint8Array) => {\n console.log(event, decodedData);\n});\n```\n\n### `websocketConnected`\n\nWill be triggered as soon as a WebSocket connection is established. The WebSocket client object is passed.\n\n```ts\nconnection.on(ControlEvent.WEBSOCKET_CONNECTED, (client: TikTokWsClient) => {\n console.log('WebSocket Client:', websocketClient.connection);\n});\n```\n\n### `error`\n\nGeneral error event. You should handle this.\n\n```ts\nconnection.on(ControlEvent.ERROR, err => {\n console.error('Error!', err);\n});\n```\n\n## Message Events\n\n### `member`\n\nTriggered every time a new viewer joins the live stream.\n\n```ts\nconnection.on(WebcastEvent.MEMBER, (data: WebcastMemberMessage) => {\n console.log(`${data.uniqueId} joins the stream!`);\n});\n```\n\n⚡ See Data Structure
\n\n### `chat`\n\nTriggered every time a new chat comment arrives.\n\n```ts\nconnection.on(WebcastEvent.CHAT, (data: WebcastChatMessage) => {\n console.log(`${data.uniqueId} -> ${data.comment}`);\n});\n```\n\n⚡ See Data Structure
\n\n### `gift`\n\nTriggered every time a gift arrives. You will receive additional information via the `extendedGiftInfo` attribute when\nyou enable the [`enableExtendedGiftInfo`](#params-and-options) option.\n\n> **NOTE:** Users have the capability to send gifts in a streak. This increases the `repeatCount` value until the user\n> terminates the streak. During this time new gift events are triggered again and again with an increased `repeatCount`\n> value. It should be noted that after the end of the streak, another gift event is triggered, which signals the end of\n> the streak via `repeatEnd`:`true`. This applies only to gifts with `giftType`:`1`. This means that even if the user\n> sends a `giftType`:`1` gift only once, you will receive the event twice. Once with `repeatEnd`:`false` and once\n> with `repeatEnd`:`true`. Therefore, the event should be handled as follows:\n\n```ts\nconnection.on(WebcastEvent.GIFT, (event: WebcastGiftMessage) => {\n if (data.giftType === 1 && !data.repeatEnd) {\n // Streak in progress => show only temporary\n console.log(`${data.uniqueId} is sending gift ${data.giftName} x${data.repeatCount}`);\n } else {\n // Streak ended or non-streakable gift => process the gift with final repeat_count\n console.log(`${data.uniqueId} has sent gift ${data.giftName} x${data.repeatCount}`);\n }\n});\n```\n\n⚡ See Data Structure
\n\n### `roomUser`\n\nTriggered every time a statistic message arrives. This message currently contains the viewer count and a top gifter\nlist.\n\n```ts\nconnection.on(WebcastEvent.ROOM_USER, data => {\n console.log(`Viewer Count: ${data.viewerCount}`);\n});\n```\n\n⚡ See Data Structure
\n\n### `like`\n\nTriggered when a viewer sends likes to the streamer. For streams with many viewers, this event is not always triggered\nby TikTok.\n\n```ts\nconnection.on(WebcastEvent.LIKE, data => {\n console.log(`${data.uniqueId} sent ${data.likeCount} likes, total likes: ${data.totalLikeCount}`);\n});\n```\n\n⚡ See Data Structure
\n\n```json5\n{\n likeCount: 6,\n // likes given by the user (taps on screen)\n totalLikeCount: 21349,\n // likes that this stream has received in total (from all users)\n userId: \"6813181309701719620\",\n secUid: \"\",\n uniqueId: \"zerodytester\",\n nickname: \"Zerody Tester\",\n profilePictureUrl: \"https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-...webp\",\n followRole: 0,\n // 0 = none; 1 = follower; 2 = friends,\n userBadges: [\n {\n type: \"pm_mt_moderator_im\",\n name: \"Moderator\"\n },\n {\n type: \"image\",\n displayType: 1,\n url: \"https://p19-webcast.tiktokcdn.com/webcast-va/rankl...image\"\n },\n {\n type: \"image\",\n displayType: 1,\n url: \"https://p19-webcast.tiktokcdn.com/webcast-va/....~...image\"\n }\n ],\n userDetails: {\n createTime: \"0\",\n bioDescription: \"\",\n profilePictureUrls: [\n \"https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-...webp\",\n \"https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-...webp\",\n \"https://p19-sign.tiktokcdn-us.com/tos-useast5-avt-...webp\",\n \"https://p16-sign.tiktokcdn-us.com/tos-useast5-avt-...jpeg\"\n ]\n },\n followInfo: {\n followingCount: 617,\n followerCount: 112,\n followStatus: 1,\n pushStatus: 0\n },\n isModerator: false,\n isNewGifter: false,\n isSubscriber: false,\n topGifterRank: null,\n msgId: \"7137750883651619630\",\n createTime: \"1661887134554\",\n displayType: \"pm_mt_msg_viewer\",\n label: \"{0:user} liked the LIVE\"\n}\n```\n\n
\n\n### `social`\n\nTriggered every time someone shares the stream or follows the host.\n\n```ts\nconnection.on(WebcastEvent.SOCIAL, data => {\n console.log('social event data:', data);\n});\n```\n\n⚡ See Data Structure
\n\n### `emote`\n\nTriggered every time a subscriber sends an emote (sticker).\n\n```ts\nconnection.on(WebcastEvent.EMOTE, (data: WebcastEmoteChatMessage) => {\n console.log('emote received', data);\n});\n```\n\n⚡ See Data Structure