16 KiB
TikTok Live Java
❤️❤️🎁 Connect to TikTok live in 3 lines 🎁❤️❤️
Introduction
A Java library inspired by TikTokLive and TikTokLiveSharp. Use it to receive live stream events such as comments and gifts in realtime from TikTok 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, Gifts, Subscriptions, Viewers, Follows, Shares, Questions, Likes and Battles can be tracked.
Join the support discord and visit the #java-support channel for questions, contributions and ideas. Feel free to make pull requests with missing/new features, fixes, etc
Do you prefer other programming languages?
- Node orginal: TikTok-Live-Connector by @zerodytrash
- Python rewrite: TikTokLive by @isaackogan
- Go rewrite: GoTikTokLive by @Davincible
- C# rewrite: TikTokLiveSharp by @frankvHoof93
NOTE: This is not an official API. It's a reverse engineering project.
Overview
Getting started
- Install the package via Maven
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.github.jwdeveloper.TikTok-Live-Java</groupId>
<artifactId>Client</artifactId>
<version>NOT_FOUND</version>
<scope>compile</scope>
</dependency>
</dependencies>
- Create your first chat connection
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();
- Configure (optional)
TikTokLive.newClient("bangbetmenygy")
.configure((settings) ->
{
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
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
settings.setRoomId("XXXXXXXXXXXXXXXXX");
})
.buildAndConnect();
//
Events
Control:
Message:
- onEvent
- onRoom
- onGiftCombo
- onJoin
- onSubscribe
- onRoomUserInfo
- onGift
- onShare
- onUnhandledSocial
- onQuestion
- onEmote
- onComment
- onLike
- onLivePaused
- onFollow
- onLiveEnded
Debug:
Examples
onConnected TikTokConnectedEvent
Triggered when the connection is successfully established.
TikTokLive.newClient("host-name")
.onConnected((liveClient, event) ->
{
})
.buildAndConnect();
onDisconnected TikTokDisconnectedEvent
Triggered when the connection gets disconnected. In that case you can call connect() again to have a reconnect logic. Note that you should wait a little bit before attempting a reconnect to to avoid being rate-limited.
TikTokLive.newClient("host-name")
.onDisconnected((liveClient, event) ->
{
})
.buildAndConnect();
onError TikTokErrorEvent
General error event. You should handle this.
TikTokLive.newClient("host-name")
.onError((liveClient, event) ->
{
})
.buildAndConnect();
onReconnecting TikTokReconnectingEvent
TikTokLive.newClient("host-name")
.onReconnecting((liveClient, event) ->
{
})
.buildAndConnect();
onEvent TikTokEvent
Base class for all events
TikTokLive.newClient("host-name")
.onEvent((liveClient, event) ->
{
})
.buildAndConnect();
onRoom TikTokRoomEvent
TikTokLive.newClient("host-name")
.onRoom((liveClient, event) ->
{
})
.buildAndConnect();
onGiftCombo TikTokGiftComboEvent
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
TikTokLive.newClient("host-name")
.onGiftCombo((liveClient, event) ->
{
})
.buildAndConnect();
onJoin TikTokJoinEvent
TikTokLive.newClient("host-name")
.onJoin((liveClient, event) ->
{
})
.buildAndConnect();
onSubscribe TikTokSubscribeEvent
Triggers when a user creates a subscription.
TikTokLive.newClient("host-name")
.onSubscribe((liveClient, event) ->
{
})
.buildAndConnect();
onRoomUserInfo TikTokRoomUserInfoEvent
Only top 5 users in ranking has detailed data
rest has only ID
TikTokLive.newClient("host-name")
.onRoomUserInfo((liveClient, event) ->
{
})
.buildAndConnect();
onGift TikTokGiftEvent
Triggered when user sends gifts that has no combo (most of expensive gifts) or if combo has finished
TikTokLive.newClient("host-name")
.onGift((liveClient, event) ->
{
})
.buildAndConnect();
onShare TikTokShareEvent
Triggers when a user shares the stream. Based on social event.
TikTokLive.newClient("host-name")
.onShare((liveClient, event) ->
{
})
.buildAndConnect();
onUnhandledSocial TikTokUnhandledSocialEvent
TikTokLive.newClient("host-name")
.onUnhandledSocial((liveClient, event) ->
{
})
.buildAndConnect();
onQuestion TikTokQuestionEvent
Triggered every time someone asks a new question via the question feature.
TikTokLive.newClient("host-name")
.onQuestion((liveClient, event) ->
{
})
.buildAndConnect();
onEmote TikTokEmoteEvent
Triggered every time a subscriber sends an emote (sticker).
TikTokLive.newClient("host-name")
.onEmote((liveClient, event) ->
{
})
.buildAndConnect();
onComment TikTokCommentEvent
Triggered every time a new chat comment arrives.
TikTokLive.newClient("host-name")
.onComment((liveClient, event) ->
{
})
.buildAndConnect();
onLike TikTokLikeEvent
Triggered when a viewer sends likes to the streamer. For streams with many viewers, this event is not always triggered by TikTok.
TikTokLive.newClient("host-name")
.onLike((liveClient, event) ->
{
})
.buildAndConnect();
onLivePaused TikTokLivePausedEvent
TikTokLive.newClient("host-name")
.onLivePaused((liveClient, event) ->
{
})
.buildAndConnect();
onFollow TikTokFollowEvent
Triggers when a user follows the streamer. Based on social event.
TikTokLive.newClient("host-name")
.onFollow((liveClient, event) ->
{
})
.buildAndConnect();
onLiveEnded TikTokLiveEndedEvent
Triggered when the live stream gets terminated by the host. Will also trigger the TikTokDisconnectedEvent event.
TikTokLive.newClient("host-name")
.onLiveEnded((liveClient, event) ->
{
})
.buildAndConnect();
onWebsocketResponse TikTokWebsocketResponseEvent
TikTokLive.newClient("host-name")
.onWebsocketResponse((liveClient, event) ->
{
})
.buildAndConnect();
onWebsocketUnhandledMessage TikTokWebsocketUnhandledMessageEvent
Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the use case.
TikTokLive.newClient("host-name")
.onWebsocketUnhandledMessage((liveClient, event) ->
{
})
.buildAndConnect();
onWebsocketMessage TikTokWebsocketMessageEvent
Triggered every time a protobuf encoded webcast message arrives. You can deserialize the binary object depending on the use case.
TikTokLive.newClient("host-name")
.onWebsocketMessage((liveClient, event) ->
{
})
.buildAndConnect();
Listener Example
{{listener-content}}
Contributing
Your improvements are welcome! Feel free to open an issue or pull request.