From 3ed1055c16e195cf338366f08ec1db3c62c941c2 Mon Sep 17 00:00:00 2001 From: Jacek W Date: Thu, 12 Oct 2023 04:45:46 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 440 +++++++++++++++++++++++++----------------------------- 1 file changed, 206 insertions(+), 234 deletions(-) diff --git a/README.md b/README.md index 6e3a308..4e5b529 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
-

TikTokLive Java

+

TikTok Live Java

❤️❤️🎁 *Connect to TikTok live in 3 lines* 🎁❤️❤️ @@ -29,7 +29,7 @@
# 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. +A Java library inspired by [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. @@ -69,11 +69,6 @@ Do you prefer other programming languages? NOT_FOUND compile - - com.google.code.gson - gson - 2.10.1 - ``` @@ -81,169 +76,115 @@ Do you prefer other programming languages? ```java -package io.github.jwdeveloper.tiktok; +TikTokLive.newClient("bangbetmenygy") + .onGift((liveClient, event) -> + { + String profileName = event.getUser().getProfileName(); + String message = switch (event.getGift()) { + case ROSE -> "ROSE!"; + case GG -> "GOOD GAME"; + case TIKTOK -> "Ye"; + case CORGI -> "Nice gift"; + default -> "Thank you for " + event.getGift().getName(); + }; + System.out.println(profileName + " sends " + message); + }) + .onGiftCombo((liveClient, event) -> + { + String giftName = event.getGift().getName(); + int combo = event.getCombo(); + String message = switch (event.getComboState()) { + case Begin -> "Combo begin! "; + case Active -> "Combo Active! "; + case Finished -> "Combo Finished! "; + }; + System.out.println(message + combo + " " + giftName); + }) + .onJoin((liveClient, event) -> + { + String profileName = event.getUser().getProfileName(); + System.out.println(profileName + "Hello on my stream! "); + }) + .onConnected((liveClient, event) -> + { + System.out.println("Connected to live "); + }) + .onError((liveClient, event) -> + { + System.out.println("Error! " + event.getException().getMessage()); + }) + .buildAndConnect(); -import io.github.jwdeveloper.tiktok.utils.ConsoleColors; +``` +3. Configure (optional) -import java.io.IOException; -import java.time.Duration; -import java.util.logging.Level; +```java -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 -> + TikTokLive.newClient("bangbetmenygy") + .configure((settings) -> { - 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 + settings.setHostName("bangbetmenygy"); // This method is useful in case you want change hostname later + settings.setClientLanguage("en"); // Language + settings.setTimeout(Duration.ofSeconds(2)); // Connection timeout + settings.setLogLevel(Level.ALL); // Log level + settings.setPrintToConsole(true); // Printing all logs to console even if log level is Level.OFF + settings.setHandleExistingEvents(true); // Invokes all TikTok events that had occurred before connection + settings.setRetryOnConnectionFailure(true); // Reconnecting if TikTok user is offline + settings.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"); + settings.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"); + settings.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 / __/ - |_| |_|_|\_\ |_|\___/|_|\_\_____|_| \_/ \___| - """); - - } -} - + .buildAndConnect(); + // ``` + + ## Events **Control**: -- [onReconnecting](#onreconnecting-tiktokreconnectingevent) - [onConnected](#onconnected-tiktokconnectedevent) - [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onError](#onerror-tiktokerrorevent) +- [onReconnecting](#onreconnecting-tiktokreconnectingevent) **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) +- [onRoom](#onroom-tiktokroomevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onJoin](#onjoin-tiktokjoinevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) +- [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) +- [onGift](#ongift-tiktokgiftevent) +- [onShare](#onshare-tiktokshareevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) +- [onQuestion](#onquestion-tiktokquestionevent) +- [onEmote](#onemote-tiktokemoteevent) +- [onComment](#oncomment-tiktokcommentevent) +- [onLike](#onlike-tiktoklikeevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) **Debug**: -- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) +- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [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) @@ -305,15 +246,13 @@ TikTokLive.newClient("host-name")
-## onEmote [TikTokEmoteEvent](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) - Triggered every time a subscriber sends an emote (sticker). - ```java TikTokLive.newClient("host-name") -.onEmote((liveClient, event) -> +.onReconnecting((liveClient, event) -> { }) @@ -325,13 +264,63 @@ TikTokLive.newClient("host-name")
-## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## 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(); +``` + + + +
+ + +## 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") -.onUnhandledSocial((liveClient, event) -> +.onRoom((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) + + + Triggered every time gift is sent + + @see GiftSendType it has 3 states + +

Example when user sends gift with combo

+

>Combo: 1 -> comboState = GiftSendType.Begin

+

Combo: 4 -> comboState = GiftSendType.Active

+

Combo: 8 -> comboState = GiftSendType.Active

+

Combo: 12 -> comboState = GiftSendType.Finsihed

+ + Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + + +```java +TikTokLive.newClient("host-name") +.onGiftCombo((liveClient, event) -> { }) @@ -361,53 +350,15 @@ TikTokLive.newClient("host-name")
-## onLiveEnded [TikTokLiveEndedEvent](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) - Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. + Triggers when a user creates a subscription. ```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) -> +.onSubscribe((liveClient, event) -> { }) @@ -440,13 +391,55 @@ 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) +## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) + + + Triggered when user sends gifts that has + no combo (most of expensive gifts) + or if combo has finished + + +```java +TikTokLive.newClient("host-name") +.onGift((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(); +``` + + + +
+ + +## 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") -.onGiftCombo((liveClient, event) -> +.onUnhandledSocial((liveClient, event) -> { }) @@ -478,15 +471,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) +## onEmote [TikTokEmoteEvent](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. + Triggered every time a subscriber sends an emote (sticker). ```java TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> +.onEmote((liveClient, event) -> { }) @@ -515,26 +508,6 @@ 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) - - - Triggers when a user follows the streamer. Based on social event. - - -```java -TikTokLive.newClient("host-name") -.onFollow((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - -
@@ -558,13 +531,13 @@ TikTokLive.newClient("host-name")
-## onRoom [TikTokRoomEvent](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) ```java TikTokLive.newClient("host-name") -.onRoom((liveClient, event) -> +.onLivePaused((liveClient, event) -> { }) @@ -576,15 +549,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) +## onFollow [TikTokFollowEvent](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. + Triggers when a user follows the streamer. Based on social event. ```java TikTokLive.newClient("host-name") -.onGift((liveClient, event) -> +.onFollow((liveClient, event) -> { }) @@ -596,15 +569,33 @@ 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) +## onLiveEnded [TikTokLiveEndedEvent](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 + Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. ```java TikTokLive.newClient("host-name") -.onEvent((liveClient, event) -> +.onLiveEnded((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) -> { }) @@ -633,24 +624,6 @@ 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) - - - -```java -TikTokLive.newClient("host-name") -.onWebsocketResponse((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - -
@@ -673,7 +646,6 @@ TikTokLive.newClient("host-name") -

## Listener Example From 307f0091544e9e72320984258222106d364ccbe8 Mon Sep 17 00:00:00 2001 From: Jacek W Date: Thu, 12 Oct 2023 04:58:30 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 480 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 273 insertions(+), 207 deletions(-) diff --git a/README.md b/README.md index 4e5b529..af2882a 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,8 @@ Do you prefer other programming languages? #### Overview - [Getting started](#getting-started) -- [Configuration](#configuration) -- [Methods](#methods) - [Events](#events) +- [Listeners](#listeners) - [Contributing](#contributing) ## Getting started @@ -152,48 +151,48 @@ TikTokLive.newClient("bangbetmenygy") **Control**: -- [onConnected](#onconnected-tiktokconnectedevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onError](#onerror-tiktokerrorevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) +- [onConnected](#onconnected-tiktokconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) **Message**: - [onEvent](#onevent-tiktokevent) -- [onRoom](#onroom-tiktokroomevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) -- [onJoin](#onjoin-tiktokjoinevent) - [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) -- [onGift](#ongift-tiktokgiftevent) -- [onShare](#onshare-tiktokshareevent) -- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) -- [onQuestion](#onquestion-tiktokquestionevent) -- [onEmote](#onemote-tiktokemoteevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) - [onComment](#oncomment-tiktokcommentevent) - [onLike](#onlike-tiktoklikeevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) +- [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) +- [onEmote](#onemote-tiktokemoteevent) - [onFollow](#onfollow-tiktokfollowevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onJoin](#onjoin-tiktokjoinevent) +- [onShare](#onshare-tiktokshareevent) +- [onQuestion](#onquestion-tiktokquestionevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onRoom](#onroom-tiktokroomevent) +- [onGift](#ongift-tiktokgiftevent) **Debug**: -- [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) -- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) +- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) +- [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) # Examples
-## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onError [TikTokErrorEvent](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. + General error event. You should handle this. ```java TikTokLive.newClient("host-name") -.onConnected((liveClient, event) -> +.onError((liveClient, event) -> { }) @@ -226,15 +225,15 @@ 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) +## onConnected [TikTokConnectedEvent](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 is successfully established. ```java TikTokLive.newClient("host-name") -.onError((liveClient, event) -> +.onConnected((liveClient, event) -> { }) @@ -281,72 +280,6 @@ TikTokLive.newClient("host-name") -
- - -## 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(); -``` - - - -
- - -## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) - - - Triggered every time gift is sent - - @see GiftSendType it has 3 states - -

Example when user sends gift with combo

-

>Combo: 1 -> comboState = GiftSendType.Begin

-

Combo: 4 -> comboState = GiftSendType.Active

-

Combo: 8 -> comboState = GiftSendType.Active

-

Combo: 12 -> comboState = GiftSendType.Finsihed

- - Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered - - -```java -TikTokLive.newClient("host-name") -.onGiftCombo((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(); -``` - - -
@@ -370,116 +303,15 @@ 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) +## onLiveEnded [TikTokLiveEndedEvent](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(); -``` - - - -
- - -## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) - - - Triggered when user sends gifts that has - no combo (most of expensive gifts) - or if combo has finished + Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. ```java TikTokLive.newClient("host-name") -.onGift((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(); -``` - - - -
- - -## 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(); -``` - - - -
- - -## 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(); -``` - - - -
- - -## 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) -> +.onLiveEnded((liveClient, event) -> { }) @@ -531,13 +363,54 @@ 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) +## 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(); +``` + + + +
+ + +## 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") -.onLivePaused((liveClient, event) -> +.onUnhandledSocial((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) -> { }) @@ -569,15 +442,13 @@ TikTokLive.newClient("host-name")
-## onLiveEnded [TikTokLiveEndedEvent](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) - Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. - ```java TikTokLive.newClient("host-name") -.onLiveEnded((liveClient, event) -> +.onJoin((liveClient, event) -> { }) @@ -589,13 +460,143 @@ 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) +## 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(); +``` + + + +
+ + +## 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(); +``` + + + +
+ + +## 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") -.onWebsocketResponse((liveClient, event) -> +.onLivePaused((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) + + + Triggered every time gift is sent + + @see GiftSendType it has 3 states + +

Example when user sends gift with combo

+

>Combo: 1 -> comboState = GiftSendType.Begin

+

Combo: 4 -> comboState = GiftSendType.Active

+

Combo: 8 -> comboState = GiftSendType.Active

+

Combo: 12 -> comboState = GiftSendType.Finsihed

+ + Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + + +```java +TikTokLive.newClient("host-name") +.onGiftCombo((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 when user sends gifts that has + no combo (most of expensive gifts) + or if combo has finished + + +```java +TikTokLive.newClient("host-name") +.onGift((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) -> { }) @@ -627,15 +628,13 @@ 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) +## onWebsocketResponse [TikTokWebsocketResponseEvent](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) -> +.onWebsocketResponse((liveClient, event) -> { }) @@ -648,11 +647,78 @@ TikTokLive.newClient("host-name")
-## Listener Example +## Listeners ```java -{{listener-content}} + + /** + * + * Listeners are an alternative way of handling events. + * I would to suggest to use then when logic of handing event + * is more complex + * + */ + public static void main(String[] args) throws IOException { + showLogo(); + CustomListener customListener = new CustomListener(); + + TikTokLive.newClient(SimpleExample.TIKTOK_HOSTNAME) + .addListener(customListener) + .buildAndConnect(); + System.in.read(); + } + + /** + * + * Method in TikTokEventListener should meet 4 requirements to be detected + * - must have @TikTokEventHandler annotation + * - must have 2 parameters + * - first parameter must be LiveClient + * - second must be class that extending TikTokEvent + */ + + public static class CustomListener implements TikTokEventListener { + + @TikTokEventHandler + public void onLike(LiveClient liveClient, TikTokLikeEvent event) { + System.out.println(event.toString()); + } + + @TikTokEventHandler + public void onError(LiveClient liveClient, TikTokErrorEvent event) { + // event.getException().printStackTrace(); + } + + @TikTokEventHandler + public void onComment(LiveClient liveClient, TikTokCommentEvent event) { + var userName = event.getUser().getName(); + var text = event.getText(); + liveClient.getLogger().info(userName + ": " + text); + } + + @TikTokEventHandler + public void onGift(LiveClient liveClient, TikTokGiftEvent event) { + var message = switch (event.getGift()) { + case ROSE -> "Thanks :)"; + case APPETIZERS -> ":OO"; + case APRIL -> ":D"; + case TIKTOK -> ":P"; + case CAP -> ":F"; + default -> ":I"; + }; + liveClient.getLogger().info(message); + } + + @TikTokEventHandler + public void onAnyEvent(LiveClient liveClient, TikTokEvent event) { + liveClient.getLogger().info(event.getClass().getSimpleName()); + } + + } + + // ``` + ## Contributing Your improvements are welcome! Feel free to open an issue or pull request. From 331d1988d4c2d490ec16397d8ca03d3ffa430103 Mon Sep 17 00:00:00 2001 From: Jacek W Date: Thu, 12 Oct 2023 05:16:10 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 353 +++++++++++++++++++++++++----------------------------- 1 file changed, 165 insertions(+), 188 deletions(-) diff --git a/README.md b/README.md index af2882a..c22de2e 100644 --- a/README.md +++ b/README.md @@ -152,39 +152,38 @@ TikTokLive.newClient("bangbetmenygy") **Control**: - [onError](#onerror-tiktokerrorevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onConnected](#onconnected-tiktokconnectedevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) **Message**: - [onEvent](#onevent-tiktokevent) -- [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) -- [onComment](#oncomment-tiktokcommentevent) -- [onLike](#onlike-tiktoklikeevent) +- [onRoom](#onroom-tiktokroomevent) - [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) -- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) -- [onEmote](#onemote-tiktokemoteevent) -- [onFollow](#onfollow-tiktokfollowevent) +- [onComment](#oncomment-tiktokcommentevent) - [onJoin](#onjoin-tiktokjoinevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) - [onShare](#onshare-tiktokshareevent) - [onQuestion](#onquestion-tiktokquestionevent) +- [onLike](#onlike-tiktoklikeevent) - [onLivePaused](#onlivepaused-tiktoklivepausedevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) -- [onRoom](#onroom-tiktokroomevent) - [onGift](#ongift-tiktokgiftevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onEmote](#onemote-tiktokemoteevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) **Debug**: -- [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) -- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) +- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) +- [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples
- -## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java) General error event. You should handle this. @@ -203,8 +202,26 @@ TikTokLive.newClient("host-name")
+## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokConnectedEvent.java) -## 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 is successfully established. + + +```java +TikTokLive.newClient("host-name") +.onConnected((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onDisconnected [TikTokDisconnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokDisconnectedEvent.java) Triggered when the connection gets disconnected. In that case you can call connect() again to have a reconnect logic. @@ -224,28 +241,7 @@ TikTokLive.newClient("host-name")
- -## 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(); -``` - - - -
- - -## 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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java) @@ -262,8 +258,7 @@ 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) +## onEvent [TikTokEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/common/TikTokEvent.java) Base class for all events @@ -282,16 +277,13 @@ 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) +## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomEvent.java) - Triggers when a user creates a subscription. - ```java TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> +.onRoom((liveClient, event) -> { }) @@ -302,68 +294,7 @@ TikTokLive.newClient("host-name")
- -## 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(); -``` - - - -
- - -## 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(); -``` - - - -
- - -## onRoomUserInfo [TikTokRoomUserInfoEvent](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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomUserInfoEvent.java) Only top 5 users in ranking has detailed data @@ -383,34 +314,15 @@ TikTokLive.newClient("host-name")
- -## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java) - -```java -TikTokLive.newClient("host-name") -.onUnhandledSocial((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 new chat comment arrives. ```java TikTokLive.newClient("host-name") -.onEmote((liveClient, event) -> +.onComment((liveClient, event) -> { }) @@ -421,8 +333,24 @@ TikTokLive.newClient("host-name")
+## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) -## onFollow [TikTokFollowEvent](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(); +``` + + + +
+ +## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java) Triggers when a user follows the streamer. Based on social event. @@ -441,14 +369,15 @@ TikTokLive.newClient("host-name")
- -## onJoin [TikTokJoinEvent](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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) + Triggers when a user creates a subscription. + ```java TikTokLive.newClient("host-name") -.onJoin((liveClient, event) -> +.onSubscribe((liveClient, event) -> { }) @@ -459,8 +388,7 @@ TikTokLive.newClient("host-name")
- -## onShare [TikTokShareEvent](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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java) Triggers when a user shares the stream. Based on social event. @@ -479,8 +407,7 @@ 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) +## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) Triggered every time someone asks a new question via the question feature. @@ -499,8 +426,26 @@ TikTokLive.newClient("host-name")
+## onLike [TikTokLikeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokLikeEvent.java) -## onLivePaused [TikTokLivePausedEvent](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(); +``` + + + +
+ +## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java) @@ -517,8 +462,83 @@ TikTokLive.newClient("host-name")
+## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) -## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) + + Triggered when user sends gifts that has + no combo (most of expensive gifts) + or if combo has finished + + +```java +TikTokLive.newClient("host-name") +.onGift((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onUnhandledSocial((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveEndedEvent.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(); +``` + + + +
+ +## onEmote [TikTokEmoteEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokEmoteEvent.java) + + + Triggered every time a subscriber sends an emote (sticker). + + +```java +TikTokLive.newClient("host-name") +.onEmote((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) Triggered every time gift is sent @@ -547,14 +567,13 @@ TikTokLive.newClient("host-name")
- -## onRoom [TikTokRoomEvent](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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketResponseEvent.java) ```java TikTokLive.newClient("host-name") -.onRoom((liveClient, event) -> +.onWebsocketResponse((liveClient, event) -> { }) @@ -565,50 +584,7 @@ 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) - - - Triggered when user sends gifts that has - no combo (most of expensive gifts) - or if combo has finished - - -```java -TikTokLive.newClient("host-name") -.onGift((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(); -``` - - - -
- - -## onWebsocketUnhandledMessage [TikTokWebsocketUnhandledMessageEvent](https://github.com/jwdeveloper/TikTok-Live-Java/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/events/messages.java) +## onWebsocketUnhandledMessage [TikTokWebsocketUnhandledMessageEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketUnhandledMessageEvent.java) Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the use case. @@ -627,14 +603,15 @@ 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) +## onWebsocketMessage [TikTokWebsocketMessageEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketMessageEvent.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") -.onWebsocketResponse((liveClient, event) -> +.onWebsocketMessage((liveClient, event) -> { }) From a01c175a61fb3faf5f831dbec2b998f596297419 Mon Sep 17 00:00:00 2001 From: Jacek W Date: Thu, 12 Oct 2023 05:19:26 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 345 ++++++++++++++++++++++++++---------------------------- 1 file changed, 168 insertions(+), 177 deletions(-) diff --git a/README.md b/README.md index c22de2e..d4bdcb7 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,6 @@ Do you prefer other programming languages? TikTokLive.newClient("bangbetmenygy") .onGift((liveClient, event) -> { - String profileName = event.getUser().getProfileName(); String message = switch (event.getGift()) { case ROSE -> "ROSE!"; case GG -> "GOOD GAME"; @@ -86,23 +85,15 @@ TikTokLive.newClient("bangbetmenygy") case CORGI -> "Nice gift"; default -> "Thank you for " + event.getGift().getName(); }; - System.out.println(profileName + " sends " + message); + System.out.println(event.getUser().getProfileName() + " sends " + message); }) .onGiftCombo((liveClient, event) -> { - String giftName = event.getGift().getName(); - int combo = event.getCombo(); - String message = switch (event.getComboState()) { - case Begin -> "Combo begin! "; - case Active -> "Combo Active! "; - case Finished -> "Combo Finished! "; - }; - System.out.println(message + combo + " " + giftName); + System.out.println(event.getComboState()+ " " + event.getCombo() + " " + event.getGift().getName()); }) .onJoin((liveClient, event) -> { - String profileName = event.getUser().getProfileName(); - System.out.println(profileName + "Hello on my stream! "); + System.out.println(event.getUser().getProfileName() + "Hello on my stream! "); }) .onConnected((liveClient, event) -> { @@ -151,29 +142,29 @@ TikTokLive.newClient("bangbetmenygy") **Control**: -- [onError](#onerror-tiktokerrorevent) - [onConnected](#onconnected-tiktokconnectedevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) +- [onError](#onerror-tiktokerrorevent) **Message**: - [onEvent](#onevent-tiktokevent) +- [onShare](#onshare-tiktokshareevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onRoom](#onroom-tiktokroomevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onJoin](#onjoin-tiktokjoinevent) - [onRoomUserInfo](#onroomuserinfo-tiktokroomuserinfoevent) - [onComment](#oncomment-tiktokcommentevent) -- [onJoin](#onjoin-tiktokjoinevent) -- [onFollow](#onfollow-tiktokfollowevent) -- [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onShare](#onshare-tiktokshareevent) -- [onQuestion](#onquestion-tiktokquestionevent) -- [onLike](#onlike-tiktoklikeevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) - [onGift](#ongift-tiktokgiftevent) -- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onLike](#onlike-tiktoklikeevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) +- [onQuestion](#onquestion-tiktokquestionevent) - [onEmote](#onemote-tiktokemoteevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onUnhandledSocial](#onunhandledsocial-tiktokunhandledsocialevent) **Debug**: @@ -181,25 +172,6 @@ TikTokLive.newClient("bangbetmenygy") - [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples -
- -## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java) - - - General error event. You should handle this. - - -```java -TikTokLive.newClient("host-name") -.onError((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - -
## onConnected [TikTokConnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokConnectedEvent.java) @@ -219,6 +191,23 @@ TikTokLive.newClient("host-name") +
+ +## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onReconnecting((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onDisconnected [TikTokDisconnectedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokDisconnectedEvent.java) @@ -241,13 +230,15 @@ TikTokLive.newClient("host-name")
-## onReconnecting [TikTokReconnectingEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokReconnectingEvent.java) +## onError [TikTokErrorEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokErrorEvent.java) + General error event. You should handle this. + ```java TikTokLive.newClient("host-name") -.onReconnecting((liveClient, event) -> +.onError((liveClient, event) -> { }) @@ -275,6 +266,42 @@ TikTokLive.newClient("host-name") +
+ +## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.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/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onLivePaused((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onRoom [TikTokRoomEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomEvent.java) @@ -292,6 +319,52 @@ TikTokLive.newClient("host-name") +
+ +## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) + + + Triggered every time gift is sent + + @see GiftSendType it has 3 states + +

Example when user sends gift with combo

+

>Combo: 1 -> comboState = GiftSendType.Begin

+

Combo: 4 -> comboState = GiftSendType.Active

+

Combo: 8 -> comboState = GiftSendType.Active

+

Combo: 12 -> comboState = GiftSendType.Finsihed

+ + Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + + +```java +TikTokLive.newClient("host-name") +.onGiftCombo((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onJoin((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onRoomUserInfo [TikTokRoomUserInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomUserInfoEvent.java) @@ -333,89 +406,17 @@ TikTokLive.newClient("host-name")
-## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) +## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) - -```java -TikTokLive.newClient("host-name") -.onJoin((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java) - - - Triggers when a user follows the streamer. Based on social event. + Triggered when user sends gifts that has + no combo (most of expensive gifts) + or if combo has finished ```java TikTokLive.newClient("host-name") -.onFollow((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) - - - Triggers when a user creates a subscription. - - -```java -TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onShare [TikTokShareEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokShareEvent.java) - - - Triggers when a user shares the stream. Based on social event. - - -```java -TikTokLive.newClient("host-name") -.onShare((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) - - -Triggered every time someone asks a new question via the question feature. - - -```java -TikTokLive.newClient("host-name") -.onQuestion((liveClient, event) -> +.onGift((liveClient, event) -> { }) @@ -445,34 +446,15 @@ TikTokLive.newClient("host-name")
-## onLivePaused [TikTokLivePausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLivePausedEvent.java) +## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) - -```java -TikTokLive.newClient("host-name") -.onLivePaused((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) - - - Triggered when user sends gifts that has - no combo (most of expensive gifts) - or if combo has finished + Triggers when a user creates a subscription. ```java TikTokLive.newClient("host-name") -.onGift((liveClient, event) -> +.onSubscribe((liveClient, event) -> { }) @@ -483,32 +465,15 @@ TikTokLive.newClient("host-name")
-## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java) +## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) - -```java -TikTokLive.newClient("host-name") -.onUnhandledSocial((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveEndedEvent.java) - - - Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. +Triggered every time someone asks a new question via the question feature. ```java TikTokLive.newClient("host-name") -.onLiveEnded((liveClient, event) -> +.onQuestion((liveClient, event) -> { }) @@ -538,25 +503,51 @@ TikTokLive.newClient("host-name")
-## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) +## onLiveEnded [TikTokLiveEndedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveEndedEvent.java) - Triggered every time gift is sent - - @see GiftSendType it has 3 states - -

Example when user sends gift with combo

-

>Combo: 1 -> comboState = GiftSendType.Begin

-

Combo: 4 -> comboState = GiftSendType.Active

-

Combo: 8 -> comboState = GiftSendType.Active

-

Combo: 12 -> comboState = GiftSendType.Finsihed

- - Remember if comboState is Finsihed both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered + Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event. ```java TikTokLive.newClient("host-name") -.onGiftCombo((liveClient, event) -> +.onLiveEnded((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onFollow [TikTokFollowEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokFollowEvent.java) + + + Triggers when a user follows the streamer. Based on social event. + + +```java +TikTokLive.newClient("host-name") +.onFollow((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## onUnhandledSocial [TikTokUnhandledSocialEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokUnhandledSocialEvent.java) + + + +```java +TikTokLive.newClient("host-name") +.onUnhandledSocial((liveClient, event) -> { })