diff --git a/README.md b/README.md index f1528bb..6e3a308 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -
@@ -29,9 +28,10 @@
- -# Introdution -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 package 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. Besides [Chat Comments](#chat), other 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. You can also send [automatic messages](#send-chat-messages) into the chat by providing your Session ID. +# 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 @@ -81,7 +81,44 @@ Do you prefer other programming languages? ```java - TikTokLive.newClient(SimpleExample.TIKTOK_HOSTNAME) +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()) { @@ -91,10 +128,22 @@ Do you prefer other programming languages? 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()); @@ -103,44 +152,72 @@ Do you prefer other programming languages? { 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**: + **Control**: - [onReconnecting](#onreconnecting-tiktokreconnectingevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onConnected](#onconnected-tiktokconnectedevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onError](#onerror-tiktokerrorevent) -**Message**: + **Message**: -- [onEvent](#onevent-tiktokevent) +- [onEmote](#onemote-tiktokemoteevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) +- [onJoin](#onjoin-tiktokjoinevent) - [onLiveEnded](#onliveended-tiktokliveendedevent) - [onShare](#onshare-tiktokshareevent) -- [onEmote](#onemote-tiktokemoteevent) -- [onComment](#oncomment-tiktokcommentevent) -- [onLike](#onlike-tiktoklikeevent) -- [onRoom](#onroom-tiktokroomevent) -- [onJoin](#onjoin-tiktokjoinevent) -- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) - [onQuestion](#onquestion-tiktokquestionevent) - [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) -- [onGift](#ongift-tiktokgiftevent) +- [onComment](#oncomment-tiktokcommentevent) - [onFollow](#onfollow-tiktokfollowevent) +- [onLike](#onlike-tiktoklikeevent) +- [onRoom](#onroom-tiktokroomevent) +- [onGift](#ongift-tiktokgiftevent) +- [onEvent](#onevent-tiktokevent) -**Debug**: + **Debug**: - [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) @@ -149,7 +226,7 @@ Do you prefer other programming languages?
-#### onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) @@ -167,32 +244,11 @@ TikTokLive.newClient("host-name")
-#### onDisconnected [TikTokDisconnectedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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 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(); -``` - - - -
- - -#### 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. - + Triggered when the connection is successfully established. + ```java TikTokLive.newClient("host-name") @@ -208,11 +264,32 @@ TikTokLive.newClient("host-name")
-#### onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onDisconnected [TikTokDisconnectedEvent](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. + 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") @@ -228,71 +305,11 @@ TikTokLive.newClient("host-name")
-#### onEvent [TikTokEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onEmote [TikTokEmoteEvent](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(); -``` - - - -
- - -#### 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(); -``` - - - -
- - -#### 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). - + Triggered every time a subscriber sends an emote (sticker). + ```java TikTokLive.newClient("host-name") @@ -308,83 +325,7 @@ TikTokLive.newClient("host-name")
-#### 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(); -``` - - - -
- - -#### 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(); -``` - - - -
- - -#### 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(); -``` - - - -
- - -#### onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) @@ -402,16 +343,13 @@ TikTokLive.newClient("host-name")
-#### onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onJoin [TikTokJoinEvent](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) -> +.onJoin((liveClient, event) -> { }) @@ -423,15 +361,15 @@ TikTokLive.newClient("host-name")
-#### onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onLiveEnded [TikTokLiveEndedEvent](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. - + Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. + ```java TikTokLive.newClient("host-name") -.onQuestion((liveClient, event) -> +.onLiveEnded((liveClient, event) -> { }) @@ -443,15 +381,15 @@ TikTokLive.newClient("host-name")
-#### onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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 creates a subscription. - + Triggers when a user shares the stream. Based on social event. + ```java TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> +.onShare((liveClient, event) -> { }) @@ -463,7 +401,7 @@ TikTokLive.newClient("host-name")
-#### onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) @@ -481,7 +419,28 @@ TikTokLive.newClient("host-name")
-#### onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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) @@ -499,15 +458,15 @@ TikTokLive.newClient("host-name")
-#### onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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 a gift arrives. - +Triggered every time someone asks a new question via the question feature. + ```java TikTokLive.newClient("host-name") -.onGift((liveClient, event) -> +.onQuestion((liveClient, event) -> { }) @@ -519,11 +478,51 @@ TikTokLive.newClient("host-name")
-#### onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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 follows the streamer. Based on social event. + 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") @@ -539,11 +538,89 @@ TikTokLive.newClient("host-name")
-#### onWebsocketUnhandledMessage [TikTokWebsocketUnhandledMessageEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onLike [TikTokLikeEvent](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. + 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") @@ -559,7 +636,7 @@ TikTokLive.newClient("host-name")
-#### onWebsocketResponse [TikTokWebsocketResponseEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onWebsocketResponse [TikTokWebsocketResponseEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) @@ -577,11 +654,11 @@ TikTokLive.newClient("host-name")
-#### onWebsocketMessage [TikTokWebsocketMessageEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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. - + 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")