TikTokLive Java

❤️❤️🎁 *Connect to TikTok live in 3 lines* 🎁❤️❤️
# Introduction A Java library based on [TikTokLive](https://github.com/isaackogan/TikTokLive) and [TikTokLiveSharp](https://github.com/sebheron/TikTokLiveSharp). Use it to receive live stream events such as comments and gifts in realtime from [TikTok LIVE](https://www.tiktok.com/live) by connecting to TikTok's internal WebCast push service. The library includes a wrapper that connects to the WebCast service using just the username (`uniqueId`). This allows you to connect to your own live chat as well as the live chat of other streamers. No credentials are required. Events such as [Members Joining](#member), [Gifts](#gift), [Subscriptions](#subscribe), [Viewers](#roomuser), [Follows](#social), [Shares](#social), [Questions](#questionnew), [Likes](#like) and [Battles](#linkmicbattle) can be tracked. Join the support [discord](https://discord.gg/e2XwPNTBBr) and visit the `#java-support` channel for questions, contributions and ideas. Feel free to make pull requests with missing/new features, fixes, etc Do you prefer other programming languages? - **Node** orginal: [TikTok-Live-Connector](https://github.com/isaackogan/TikTok-Live-Connector) by [@zerodytrash](https://github.com/zerodytrash) - **Python** rewrite: [TikTokLive](https://github.com/isaackogan/TikTokLive) by [@isaackogan](https://github.com/isaackogan) - **Go** rewrite: [GoTikTokLive](https://github.com/Davincible/gotiktoklive) by [@Davincible](https://github.com/Davincible) - **C#** rewrite: [TikTokLiveSharp](https://github.com/frankvHoof93/TikTokLiveSharp) by [@frankvHoof93](https://github.com/frankvHoof93) **NOTE:** This is not an official API. It's a reverse engineering project. #### Overview - [Getting started](#getting-started) - [Configuration](#configuration) - [Methods](#methods) - [Events](#events) - [Contributing](#contributing) ## Getting started 1. Install the package via Maven ```xml jitpack.io https://jitpack.io com.github.jwdeveloper.TikTok-Live-Java Client NOT_FOUND compile com.google.code.gson gson 2.10.1 ``` 2. Create your first chat connection ```java package io.github.jwdeveloper.tiktok; import io.github.jwdeveloper.tiktok.utils.ConsoleColors; import java.io.IOException; import java.time.Duration; import java.util.logging.Level; public class SimpleExample { public static String TIKTOK_HOSTNAME = "szwagierkaqueen"; public static void main(String[] args) throws IOException { showLogo(); // set tiktok username TikTokLive.newClient(SimpleExample.TIKTOK_HOSTNAME) .configure(clientSettings -> { clientSettings.setHostName(SimpleExample.TIKTOK_HOSTNAME); // This method is useful in case you want change hostname later clientSettings.setClientLanguage("en"); // Language clientSettings.setTimeout(Duration.ofSeconds(2)); // Connection timeout clientSettings.setLogLevel(Level.ALL); // Log level clientSettings.setPrintToConsole(true); // Printing all logs to console even if log level is Level.OFF clientSettings.setHandleExistingEvents(true); // Invokes all TikTok events that had occurred before connection clientSettings.setRetryOnConnectionFailure(true); // Reconnecting if TikTok user is offline clientSettings.setRetryConnectionTimeout(Duration.ofSeconds(1)); // Timeout before next reconnection //Optional: Sometimes not every message from chat are send to TikTokLiveJava to fix this issue you can set sessionId // documentation how to obtain sessionId https://github.com/isaackogan/TikTok-Live-Connector#send-chat-messages // clientSettings.setSessionId("86c3c8bf4b17ebb2d74bb7fa66fd0000"); //Optional: //RoomId can be used as an override if you're having issues with HostId. //You can find it in the HTML for the livestream-page //clientSettings.setRoomId("XXXXXXXXXXXXXXXXX"); }) .onGift((liveClient, event) -> { switch (event.getGift()) { case ROSE -> print(ConsoleColors.RED, "Rose!"); case GG -> print(ConsoleColors.YELLOW, " GOOD GAME!"); case TIKTOK -> print(ConsoleColors.CYAN,"Thanks for TikTok"); default -> print(ConsoleColors.GREEN, "[Thanks for gift] ", ConsoleColors.YELLOW, event.getGift().getName(), "x", event.getCombo()); } }) .onGiftCombo((liveClient, event) -> { print(ConsoleColors.RED,"GIFT COMBO",event.getGift().getName(),event.getCombo()); }) .onConnected((client, event) -> { print(ConsoleColors.GREEN, "[Connected]"); }) .onDisconnected((liveClient, event) -> { print(ConsoleColors.RED,"[Disconnected]"); }) .onFollow((liveClient, event) -> { print(ConsoleColors.BLUE, "Follow:", ConsoleColors.WHITE_BRIGHT, event.getUser().getName()); }) .onJoin((client, event) -> { print(ConsoleColors.WHITE, "Join:", ConsoleColors.WHITE_BRIGHT, event.getUser().getName()); }) .onComment((client, event) -> { print(ConsoleColors.GREEN, event.getUser().getName(), ":", ConsoleColors.WHITE_BRIGHT, event.getText()); }) .onEvent((client, event) -> { //System.out.println("Event: " +event.getClass().getSimpleName()); }) .onError((client, event) -> { event.getException().printStackTrace(); }) .buildAndConnectAsync(); System.in.read(); } private static void print(Object... messages) { var sb = new StringBuilder(); for (var message : messages) { sb.append(message).append(" "); } System.out.println(sb); } private static void showLogo() { System.out.println(ConsoleColors.GREEN+""" _____ _ _ _____ _ _ _ s |_ _(_) | _|_ _|__ | | _| | (_)_ _____s | | | | |/ / | |/ _ \| |/ / | | \ \ / / _ \ | | | | < | | (_) | <| |___| |\ V / __/ |_| |_|_|\_\ |_|\___/|_|\_\_____|_| \_/ \___| """); } } ``` ## Events **Control**: - [onReconnecting](#onreconnecting-tiktokreconnectingevent) - [onConnected](#onconnected-tiktokconnectedevent) - [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onError](#onerror-tiktokerrorevent) **Message**: - [onEmote](#onemote-tiktokemoteevent) - [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) - [onJoin](#onjoin-tiktokjoinevent) - [onLiveEnded](#onliveended-tiktokliveendedevent) - [onShare](#onshare-tiktokshareevent) - [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) - [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) - [onQuestion](#onquestion-tiktokquestionevent) - [onSubscribe](#onsubscribe-tiktoksubscribeevent) - [onComment](#oncomment-tiktokcommentevent) - [onFollow](#onfollow-tiktokfollowevent) - [onLike](#onlike-tiktoklikeevent) - [onRoom](#onroom-tiktokroomevent) - [onGift](#ongift-tiktokgiftevent) - [onEvent](#onevent-tiktokevent) **Debug**: - [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples
## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onReconnecting((liveClient, event) -> { }) .buildAndConnect(); ```
## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered when the connection is successfully established. ```java TikTokLive.newClient("host-name") .onConnected((liveClient, event) -> { }) .buildAndConnect(); ```
## onDisconnected [TikTokDisconnectedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered when the connection gets disconnected. In that case you can call connect() again to have a reconnect logic. Note that you should wait a little bit before attempting a reconnect to to avoid being rate-limited. ```java TikTokLive.newClient("host-name") .onDisconnected((liveClient, event) -> { }) .buildAndConnect(); ```
## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) General error event. You should handle this. ```java TikTokLive.newClient("host-name") .onError((liveClient, event) -> { }) .buildAndConnect(); ```
## onEmote [TikTokEmoteEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time a subscriber sends an emote (sticker). ```java TikTokLive.newClient("host-name") .onEmote((liveClient, event) -> { }) .buildAndConnect(); ```
## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onUnhandledSocial((liveClient, event) -> { }) .buildAndConnect(); ```
## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onJoin((liveClient, event) -> { }) .buildAndConnect(); ```
## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. ```java TikTokLive.newClient("host-name") .onLiveEnded((liveClient, event) -> { }) .buildAndConnect(); ```
## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggers when a user shares the stream. Based on social event. ```java TikTokLive.newClient("host-name") .onShare((liveClient, event) -> { }) .buildAndConnect(); ```
## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onLivePaused((liveClient, event) -> { }) .buildAndConnect(); ```
## onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Only top 5 users in ranking has detailed data rest has only ID ```java TikTokLive.newClient("host-name") .onRoomUserInfo((liveClient, event) -> { }) .buildAndConnect(); ```
## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onGiftCombo((liveClient, event) -> { }) .buildAndConnect(); ```
## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time someone asks a new question via the question feature. ```java TikTokLive.newClient("host-name") .onQuestion((liveClient, event) -> { }) .buildAndConnect(); ```
## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggers when a user creates a subscription. ```java TikTokLive.newClient("host-name") .onSubscribe((liveClient, event) -> { }) .buildAndConnect(); ```
## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time a new chat comment arrives. ```java TikTokLive.newClient("host-name") .onComment((liveClient, event) -> { }) .buildAndConnect(); ```
## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggers when a user follows the streamer. Based on social event. ```java TikTokLive.newClient("host-name") .onFollow((liveClient, event) -> { }) .buildAndConnect(); ```
## onLike [TikTokLikeEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered when a viewer sends likes to the streamer. For streams with many viewers, this event is not always triggered by TikTok. ```java TikTokLive.newClient("host-name") .onLike((liveClient, event) -> { }) .buildAndConnect(); ```
## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onRoom((liveClient, event) -> { }) .buildAndConnect(); ```
## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time a gift arrives. ```java TikTokLive.newClient("host-name") .onGift((liveClient, event) -> { }) .buildAndConnect(); ```
## onEvent [TikTokEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Base class for all events ```java TikTokLive.newClient("host-name") .onEvent((liveClient, event) -> { }) .buildAndConnect(); ```
## onWebsocketUnhandledMessage [TikTokWebsocketUnhandledMessageEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the use case. ```java TikTokLive.newClient("host-name") .onWebsocketUnhandledMessage((liveClient, event) -> { }) .buildAndConnect(); ```
## onWebsocketResponse [TikTokWebsocketResponseEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) ```java TikTokLive.newClient("host-name") .onWebsocketResponse((liveClient, event) -> { }) .buildAndConnect(); ```
## onWebsocketMessage [TikTokWebsocketMessageEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the use case. ```java TikTokLive.newClient("host-name") .onWebsocketMessage((liveClient, event) -> { }) .buildAndConnect(); ```

## Listener Example ```java {{listener-content}} ``` ## Contributing Your improvements are welcome! Feel free to open an issue or pull request.