From 38b66395cbb6b36927d0ef9a38028c8382cbfe1b Mon Sep 17 00:00:00 2001 From: JW Date: Fri, 19 Jan 2024 19:31:30 +0100 Subject: [PATCH] Fixed poms files --- .../jwdeveloper/tiktok/CollectorExample.java | 2 +- README.md | 454 ++++++++++-------- .../src/main/resources/output.md | 245 ++++++---- extension-collector/README.md | 64 +++ extension-recorder/README.md | 56 +++ 5 files changed, 526 insertions(+), 295 deletions(-) diff --git a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java b/Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java index 39e8520..e75930e 100644 --- a/Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java +++ b/Examples/src/main/java/io/github/jwdeveloper/tiktok/CollectorExample.java @@ -49,7 +49,7 @@ public class CollectorExample { collector.connectDatabase(); var users = List.of("tehila_723", "dino123597", "domaxyzx", "dash4214", "obserwacje_live"); - var sessionTag = "Dupa"; + var sessionTag = "Tag1"; for (var user : users) { TikTokLive.newClient(user) .configure(liveClientSettings -> diff --git a/README.md b/README.md index a0d7ac7..3772dd9 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,7 @@ A Java library inspired by [TikTokLive](https://github.com/isaackogan/TikTokLive 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. -# Contributors -[Library documentation for contributors](https://github.com/jwdeveloper/TikTokLiveJava/wiki) +
IMAGE ALT TEXT @@ -50,6 +49,7 @@ Do you prefer other programming languages? #### Overview - [Getting started](#getting-started) - [Events](#events) +- [Extensions](#extensions) - [Listeners](#listeners) - [Contributing](#contributing) @@ -166,37 +166,79 @@ TikTokLive.newClient("bangbetmenygy") +## Events + + + **Control**: -- [onConnected](#onconnected-tiktokconnectedevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) - [onError](#onerror-tiktokerrorevent) +- [onConnected](#onconnected-tiktokconnectedevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) **Message**: - [onEvent](#onevent-tiktokevent) -- [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onQuestion](#onquestion-tiktokquestionevent) -- [onFollow](#onfollow-tiktokfollowevent) -- [onLike](#onlike-tiktoklikeevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) -- [onRoomInfo](#onroominfo-tiktokroominfoevent) -- [onShare](#onshare-tiktokshareevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) -- [onEmote](#onemote-tiktokemoteevent) -- [onGift](#ongift-tiktokgiftevent) +- [onEvent](#onevent-tiktokevent) - [onComment](#oncomment-tiktokcommentevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) +- [onRoomInfo](#onroominfo-tiktokroominfoevent) +- [onGift](#ongift-tiktokgiftevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onQuestion](#onquestion-tiktokquestionevent) +- [onShare](#onshare-tiktokshareevent) - [onLiveUnpaused](#onliveunpaused-tiktokliveunpausedevent) +- [onEmote](#onemote-tiktokemoteevent) - [onJoin](#onjoin-tiktokjoinevent) +- [onLike](#onlike-tiktoklikeevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) **Debug**: -- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) +- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) +- [onHttpResponse](#onhttpresponse-tiktokhttpresponseevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples +
+ +## 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(); +``` + + + +
+ +## 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) @@ -238,32 +280,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) +## onEvent [TikTokEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/common/TikTokEvent.java) - -```java -TikTokLive.newClient("host-name") -.onReconnecting((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## 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. +Base class for all events ```java TikTokLive.newClient("host-name") -.onError((liveClient, event) -> +.onEvent((liveClient, event) -> { }) @@ -293,91 +318,15 @@ TikTokLive.newClient("host-name")
-## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) +## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java) -Triggers when a user creates a subscription. +Triggered every time a new chat comment arrives. ```java TikTokLive.newClient("host-name") -.onSubscribe((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) -> -{ - -}) -.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(); -``` - - - -
- -## onLike [TikTokLikeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokLikeEvent.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(); -``` - - - -
- -## 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) -> +.onComment((liveClient, event) -> { }) @@ -391,6 +340,8 @@ TikTokLive.newClient("host-name") ## onRoomInfo [TikTokRoomInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomInfoEvent.java) +Triggered when LiveRoomInfo got updated such as likes, viewers, ranking .... + ```java TikTokLive.newClient("host-name") @@ -403,73 +354,6 @@ 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(); -``` - - - -
- -## 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.Finished

- -Remember if comboState is Finished both TikTokGiftComboEvent and TikTokGiftEvent event gets triggered - - -```java -TikTokLive.newClient("host-name") -.onGiftCombo((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(); -``` - - -
## onGift [TikTokGiftEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftEvent.java) @@ -493,15 +377,15 @@ TikTokLive.newClient("host-name")
-## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java) +## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) -Triggered every time a new chat comment arrives. +Triggers when a user creates a subscription. ```java TikTokLive.newClient("host-name") -.onComment((liveClient, event) -> +.onSubscribe((liveClient, event) -> { }) @@ -512,13 +396,101 @@ 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) +## 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") -.onLivePaused((liveClient, event) -> +.onFollow((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 + +@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(); +``` + + + +
+ +## 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(); +``` + + + +
+ +## 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) -> +{ + +}) +.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) -> { }) @@ -544,6 +516,25 @@ TikTokLive.newClient("host-name") +
+ +## 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(); +``` + + +
## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.java) @@ -561,6 +552,59 @@ 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) + + +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) + + + +```java +TikTokLive.newClient("host-name") +.onLivePaused((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + + +
+ +## 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") +.onWebsocketResponse((liveClient, event) -> +{ + +}) +.buildAndConnect(); +``` + + +
## onWebsocketUnhandledMessage [TikTokWebsocketUnhandledMessageEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketUnhandledMessageEvent.java) @@ -582,17 +626,17 @@ TikTokLive.newClient("host-name")
-## onWebsocketResponse [TikTokWebsocketResponseEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketResponseEvent.java) +## onHttpResponse [TikTokHttpResponseEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/http/TikTokHttpResponseEvent.java) ```java TikTokLive.newClient("host-name") - .onWebsocketResponse((liveClient, event) -> - { +.onHttpResponse((liveClient, event) -> +{ - }) - .buildAndConnect(); +}) +.buildAndConnect(); ``` @@ -602,24 +646,37 @@ TikTokLive.newClient("host-name") ## 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. +Triggered every time TikTok sends data. Data incoming as protobuf message. +You can deserialize the binary object depending on the use case. ```java TikTokLive.newClient("host-name") - .onWebsocketMessage((liveClient, event) -> - { +.onWebsocketMessage((liveClient, event) -> +{ - }) - .buildAndConnect(); +}) +.buildAndConnect(); ``` +
+ +## Extensions + +List of extensions (addons) to TiktokLiveJava +that will save your time + +- (Video Recorder)[] +- (Live data collector to database)[] + + + ## Listeners ```java @@ -694,4 +751,7 @@ public static class CustomListener implements TikTokEventListener { ## Contributing + +[Library documentation for contributors](https://github.com/jwdeveloper/TikTokLiveJava/wiki) + Your improvements are welcome! Feel free to open an issue or pull request. diff --git a/Tools-ReadmeGenerator/src/main/resources/output.md b/Tools-ReadmeGenerator/src/main/resources/output.md index 22b9542..64b3c22 100644 --- a/Tools-ReadmeGenerator/src/main/resources/output.md +++ b/Tools-ReadmeGenerator/src/main/resources/output.md @@ -126,7 +126,6 @@ TikTokLive.newClient("bangbetmenygy") { 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.setRetryOnConnectionFailure(true); // Reconnecting if TikTok user is offline @@ -152,35 +151,73 @@ TikTokLive.newClient("bangbetmenygy") **Control**: -- [onConnected](#onconnected-tiktokconnectedevent) -- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) - [onReconnecting](#onreconnecting-tiktokreconnectingevent) - [onError](#onerror-tiktokerrorevent) +- [onConnected](#onconnected-tiktokconnectedevent) +- [onDisconnected](#ondisconnected-tiktokdisconnectedevent) **Message**: - [onEvent](#onevent-tiktokevent) -- [onSubscribe](#onsubscribe-tiktoksubscribeevent) -- [onQuestion](#onquestion-tiktokquestionevent) -- [onFollow](#onfollow-tiktokfollowevent) -- [onLike](#onlike-tiktoklikeevent) -- [onLiveEnded](#onliveended-tiktokliveendedevent) -- [onRoomInfo](#onroominfo-tiktokroominfoevent) -- [onShare](#onshare-tiktokshareevent) -- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) -- [onEmote](#onemote-tiktokemoteevent) -- [onGift](#ongift-tiktokgiftevent) +- [onEvent](#onevent-tiktokevent) - [onComment](#oncomment-tiktokcommentevent) -- [onLivePaused](#onlivepaused-tiktoklivepausedevent) +- [onRoomInfo](#onroominfo-tiktokroominfoevent) +- [onGift](#ongift-tiktokgiftevent) +- [onSubscribe](#onsubscribe-tiktoksubscribeevent) +- [onFollow](#onfollow-tiktokfollowevent) +- [onGiftCombo](#ongiftcombo-tiktokgiftcomboevent) +- [onLiveEnded](#onliveended-tiktokliveendedevent) +- [onQuestion](#onquestion-tiktokquestionevent) +- [onShare](#onshare-tiktokshareevent) - [onLiveUnpaused](#onliveunpaused-tiktokliveunpausedevent) +- [onEmote](#onemote-tiktokemoteevent) - [onJoin](#onjoin-tiktokjoinevent) +- [onLike](#onlike-tiktoklikeevent) +- [onLivePaused](#onlivepaused-tiktoklivepausedevent) **Debug**: -- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) - [onWebsocketResponse](#onwebsocketresponse-tiktokwebsocketresponseevent) +- [onWebsocketUnhandledMessage](#onwebsocketunhandledmessage-tiktokwebsocketunhandledmessageevent) +- [onHttpResponse](#onhttpresponse-tiktokhttpresponseevent) - [onWebsocketMessage](#onwebsocketmessage-tiktokwebsocketmessageevent) # Examples +
+ +## 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(); +``` + + + +
+ +## 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) @@ -222,32 +259,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) +## onEvent [TikTokEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/common/TikTokEvent.java) - -```java -TikTokLive.newClient("host-name") -.onReconnecting((liveClient, event) -> -{ - -}) -.buildAndConnect(); -``` - - - -
- -## 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. + Base class for all events ```java TikTokLive.newClient("host-name") -.onError((liveClient, event) -> +.onEvent((liveClient, event) -> { }) @@ -277,15 +297,15 @@ TikTokLive.newClient("host-name")
-## onSubscribe [TikTokSubscribeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokSubscribeEvent.java) +## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java) - Triggers when a user creates a subscription. + Triggered every time a new chat comment arrives. ```java TikTokLive.newClient("host-name") -.onSubscribe((liveClient, event) -> +.onComment((liveClient, event) -> { }) @@ -296,15 +316,55 @@ TikTokLive.newClient("host-name")
-## onQuestion [TikTokQuestionEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokQuestionEvent.java) +## onRoomInfo [TikTokRoomInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomInfoEvent.java) -Triggered every time someone asks a new question via the question feature. +Triggered when LiveRoomInfo got updated such as likes, viewers, ranking .... ```java TikTokLive.newClient("host-name") -.onQuestion((liveClient, event) -> +.onRoomInfo((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 + + +```java +TikTokLive.newClient("host-name") +.onGift((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) -> { }) @@ -334,15 +394,25 @@ 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) +## onGiftCombo [TikTokGiftComboEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/gift/TikTokGiftComboEvent.java) - Triggered when a viewer sends likes to the streamer. For streams with many viewers, this event is not always triggered by TikTok. + 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") -.onLike((liveClient, event) -> +.onGiftCombo((liveClient, event) -> { }) @@ -372,13 +442,15 @@ TikTokLive.newClient("host-name")
-## onRoomInfo [TikTokRoomInfoEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/room/TikTokRoomInfoEvent.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. + ```java TikTokLive.newClient("host-name") -.onRoomInfo((liveClient, event) -> +.onQuestion((liveClient, event) -> { }) @@ -408,25 +480,13 @@ 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) +## onLiveUnpaused [TikTokLiveUnpausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveUnpausedEvent.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) -> +.onLiveUnpaused((liveClient, event) -> { }) @@ -456,17 +516,13 @@ 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) +## onJoin [TikTokJoinEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokJoinEvent.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) -> +.onJoin((liveClient, event) -> { }) @@ -477,15 +533,15 @@ TikTokLive.newClient("host-name")
-## onComment [TikTokCommentEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokCommentEvent.java) +## onLike [TikTokLikeEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/social/TikTokLikeEvent.java) - Triggered every time a new chat comment arrives. + 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") -.onComment((liveClient, event) -> +.onLike((liveClient, event) -> { }) @@ -513,30 +569,13 @@ TikTokLive.newClient("host-name")
-## onLiveUnpaused [TikTokLiveUnpausedEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/TikTokLiveUnpausedEvent.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") -.onLiveUnpaused((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) -> +.onWebsocketResponse((liveClient, event) -> { }) @@ -566,13 +605,13 @@ TikTokLive.newClient("host-name")
-## onWebsocketResponse [TikTokWebsocketResponseEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/websocket/TikTokWebsocketResponseEvent.java) +## onHttpResponse [TikTokHttpResponseEvent](https://github.com/jwdeveloper/TikTokLiveJava/blob/master/API/src/main/java/io/github/jwdeveloper/tiktok/data/events/http/TikTokHttpResponseEvent.java) ```java TikTokLive.newClient("host-name") -.onWebsocketResponse((liveClient, event) -> +.onHttpResponse((liveClient, event) -> { }) @@ -586,7 +625,8 @@ TikTokLive.newClient("host-name") ## 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. + Triggered every time TikTok sends data. Data incoming as protobuf message. + You can deserialize the binary object depending on the use case. ```java @@ -602,6 +642,17 @@ TikTokLive.newClient("host-name") +{{for item of data }} + +{{if item is 2}} + +my name is {{item.name}} + +{{else}} + +{{end}} + +{{end}}
## Listeners @@ -628,7 +679,7 @@ TikTokLive.newClient("host-name") /** * * Method in TikTokEventListener should meet 4 requirements to be detected - * - must have @TikTokEventHandler annotation + * - must have @TikTokEventObserver annotation * - must have 2 parameters * - first parameter must be LiveClient * - second must be class that extending TikTokEvent @@ -636,24 +687,24 @@ TikTokLive.newClient("host-name") public static class CustomListener implements TikTokEventListener { - @TikTokEventHandler + @TikTokEventObserver public void onLike(LiveClient liveClient, TikTokLikeEvent event) { System.out.println(event.toString()); } - @TikTokEventHandler + @TikTokEventObserver public void onError(LiveClient liveClient, TikTokErrorEvent event) { // event.getException().printStackTrace(); } - @TikTokEventHandler + @TikTokEventObserver public void onComment(LiveClient liveClient, TikTokCommentEvent event) { var userName = event.getUser().getName(); var text = event.getText(); liveClient.getLogger().info(userName + ": " + text); } - @TikTokEventHandler + @TikTokEventObserver public void onGift(LiveClient liveClient, TikTokGiftEvent event) { var message = switch (event.getGift()) { case ROSE -> "Thanks :)"; @@ -666,7 +717,7 @@ TikTokLive.newClient("host-name") liveClient.getLogger().info(message); } - @TikTokEventHandler + @TikTokEventObserver public void onAnyEvent(LiveClient liveClient, TikTokEvent event) { liveClient.getLogger().info(event.getClass().getSimpleName()); } diff --git a/extension-collector/README.md b/extension-collector/README.md index e69de29..6219870 100644 --- a/extension-collector/README.md +++ b/extension-collector/README.md @@ -0,0 +1,64 @@ +Collects live data to mongodb database + + +```xml + + + jitpack.io + https://jitpack.io + + + + + com.github.jwdeveloper.TikTok-Live-Java + Client + 1.1.0-Release + compile + + + com.github.jwdeveloper.TikTok-Live-Java + extension-collector + 1.1.0-Release + + +``` + + +Usage + +```java + public static void main(String[] args) throws IOException { + + var collector = TikTokLiveCollector.use(settings -> + { + settings.setConnectionUrl("mongodb+srv://" + mongoUser + ":" + mongoPassword + "@" + mongoDatabase + "/?retryWrites=true&w=majority"); + settings.setDatabaseName("tiktok"); + }); + collector.connectDatabase(); + + var users = List.of("tehila_723", "dino123597", "domaxyzx", "dash4214", "obserwacje_live"); + var sessionTag = "Tag1"; + for (var user : users) { + TikTokLive.newClient(user) + .configure(liveClientSettings -> + { + liveClientSettings.setPrintToConsole(true); + }) + .onError((liveClient, event) -> + { + event.getException().printStackTrace(); + }) + .addListener(collector.newListener(Map.of("sessionTag", sessionTag), document -> + { + if (document.get("dataType") == "message") { + return false; + } + return true; + })) + .buildAndConnectAsync(); + } + + System.in.read(); + collector.disconnectDatabase(); + } +``` \ No newline at end of file diff --git a/extension-recorder/README.md b/extension-recorder/README.md index e69de29..616b5af 100644 --- a/extension-recorder/README.md +++ b/extension-recorder/README.md @@ -0,0 +1,56 @@ + +Records stream to flv file + + +```xml + + + jitpack.io + https://jitpack.io + + + + + com.github.jwdeveloper.TikTok-Live-Java + Client + 1.1.0-Release + compile + + + com.github.jwdeveloper.TikTok-Live-Java + extension-recorder + 1.1.0-Release + + +``` + + +Usage + +```java + +public static void main(String[] args) { + + TikTokLive.newClient("bangbetmenygy") + .configure(liveClientSettings -> + { + liveClientSettings.setPrintToConsole(true); + }) + .onError((liveClient, event) -> + { + event.getException().printStackTrace(); + }) + .addListener(TikTokLiveRecorder.use(recorderSettings -> + { + recorderSettings.setFfmpegPath("C:\\Users\\ja\\IdeaProjects\\TikTokLiveJava\\extension-recorder\\libs\\ffmpeg.exe"); + recorderSettings.setOutputPath("C:\\Users\\ja\\IdeaProjects\\TikTokLiveJava\\extension-recorder\\out"); + recorderSettings.setOutputFileName("test.flv"); + })) + .onEvent(TikTokLiveRecorderStartedEvent.class, (liveClient, event) -> + { + System.out.println(event.getDownloadData().getFullUrl()); + }) + .buildAndConnect(); + + } +``` \ No newline at end of file