Rename pinging-task to heartbeat-task!

Added User instance to LiveUserDataMapper Response to access the retrieved user

API/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>API</artifactId>

API/src/main/java/io/github/jwdeveloper/tiktok/data/requests/LiveUserData.java

@@ -22,6 +22,7 @@
  */
 package io.github.jwdeveloper.tiktok.data.requests;
 
+import io.github.jwdeveloper.tiktok.data.models.users.User;
 import lombok.*;
 
 public class LiveUserData {
@@ -44,6 +45,7 @@ public class LiveUserData {
         private final UserStatus userStatus;
         private final String roomId;
         private final long startTime;
+        private final User user;
 
         public boolean isLiveOnline() {
             return userStatus == LiveUserData.UserStatus.Live || userStatus == LiveUserData.UserStatus.LivePaused;

API/src/main/java/io/github/jwdeveloper/tiktok/data/settings/LiveClientSettings.java

@@ -82,9 +82,9 @@ public class LiveClientSettings {
 
     /**
      * Interval of time in milliseconds between pings to TikTok
-     * @apiNote Min: 250 (0.25 seconds), Default: 5000 (5 seconds)
+     * @apiNote Min: 250 (0.25 seconds), Default: 10000 (10 seconds - TikTok Default)
      */
-    private long pingInterval = 5000;
+    private long pingInterval = 10000;
 
     /** Throw an exception on 18+ Age Restriction */
     private boolean throwOnAgeRestriction;

Client/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

Client/src/main/java/io/github/jwdeveloper/tiktok/TikTokLiveClientBuilder.java

@@ -138,7 +138,7 @@ public class TikTokLiveClientBuilder implements LiveClientBuilder {
 
         //networking
         dependance.registerSingleton(HttpClientFactory.class);
-        dependance.registerSingleton(TikTokWebSocketPingingTask.class);
+        dependance.registerSingleton(WebSocketHeartbeatTask.class);
         if (clientSettings.isOffline()) {
             dependance.registerSingleton(LiveSocketClient.class, TikTokWebSocketOfflineClient.class);
             dependance.registerSingleton(LiveHttpClient.class, TikTokLiveHttpOfflineClient.class);

Client/src/main/java/io/github/jwdeveloper/tiktok/TikTokLiveHttpOfflineClient.java

@@ -47,7 +47,7 @@ public class TikTokLiveHttpOfflineClient implements LiveHttpClient {
 
     @Override
     public LiveUserData.Response fetchLiveUserData(LiveUserData.Request request) {
-        return new LiveUserData.Response("", LiveUserData.UserStatus.Live, "offline_room_id", 0);
+        return new LiveUserData.Response("", LiveUserData.UserStatus.Live, "offline_room_id", 0, null);
     }
 
     @Override

Client/src/main/java/io/github/jwdeveloper/tiktok/http/mappers/LiveUserDataMapper.java

@@ -23,9 +23,12 @@
 package io.github.jwdeveloper.tiktok.http.mappers;
 
 import com.google.gson.*;
+import io.github.jwdeveloper.tiktok.data.models.Picture;
+import io.github.jwdeveloper.tiktok.data.models.users.User;
 import io.github.jwdeveloper.tiktok.data.requests.LiveUserData;
 import io.github.jwdeveloper.tiktok.exceptions.TikTokLiveRequestException;
 
+import java.util.List;
 import java.util.logging.Logger;
 
 public class LiveUserDataMapper
@@ -40,17 +43,18 @@ public class LiveUserDataMapper
                 throw new TikTokLiveRequestException("fetchRoomIdFromTiktokApi -> Unable to fetch roomID, contact the developer");
             }
             if (message.equals("user_not_found")) {
-                return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1);
+                return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1, null);
             }
             //live -> status 2
             //live paused -> 3
             //not live -> status 4
             var element = jsonObject.get("data");
             if (element.isJsonNull()) {
-                return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1);
+                return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1, null);
             }
             var data = element.getAsJsonObject();
             var user = data.getAsJsonObject("user");
+            var stats = data.getAsJsonObject("stats");
             var roomId = user.get("roomId").getAsString();
             var status = user.get("status").getAsInt();
 
@@ -64,10 +68,19 @@ public class LiveUserDataMapper
                 default -> LiveUserData.UserStatus.NotFound;
             };
 
-            return new LiveUserData.Response(json, statusEnum, roomId, startTime);
+            User foundUser = new User(
+                Long.parseLong(user.get("id").getAsString()),
+                user.get("uniqueId").getAsString(),
+                user.get("nickname").getAsString(),
+                new Picture(user.get("avatarLarger").getAsString()),
+                stats.get("followingCount").getAsLong(),
+                stats.get("followerCount").getAsLong(),
+                List.of());
+
+            return new LiveUserData.Response(json, statusEnum, roomId, startTime, foundUser);
         } catch (JsonSyntaxException | IllegalStateException e) {
             logger.warning("Malformed Json: '"+json+"' - Error Message: "+e.getMessage());
-            return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1);
+            return new LiveUserData.Response(json, LiveUserData.UserStatus.NotFound, "", -1, null);
         }
     }
 }

Client/src/main/java/io/github/jwdeveloper/tiktok/websocket/TikTokWebSocketClient.java

@@ -40,7 +40,7 @@ public class TikTokWebSocketClient implements LiveSocketClient {
     private final LiveClientSettings clientSettings;
     private final LiveMessagesHandler messageHandler;
     private final LiveEventsHandler tikTokEventHandler;
-    private final TikTokWebSocketPingingTask pingingTask;
+    private final WebSocketHeartbeatTask heartbeatTask;
     private WebSocketClient webSocketClient;
     private boolean isConnected;
 
@@ -48,12 +48,12 @@ public class TikTokWebSocketClient implements LiveSocketClient {
             LiveClientSettings clientSettings,
             LiveMessagesHandler messageHandler,
             LiveEventsHandler tikTokEventHandler,
-            TikTokWebSocketPingingTask pingingTask)
+            WebSocketHeartbeatTask heartbeatTask)
     {
         this.clientSettings = clientSettings;
         this.messageHandler = messageHandler;
         this.tikTokEventHandler = tikTokEventHandler;
-        this.pingingTask = pingingTask;
+        this.heartbeatTask = heartbeatTask;
         isConnected = false;
     }
 
@@ -84,7 +84,7 @@ public class TikTokWebSocketClient implements LiveSocketClient {
     private void connectDefault() {
         try {
             webSocketClient.connect();
-            pingingTask.run(webSocketClient, clientSettings.getPingInterval());
+            heartbeatTask.run(webSocketClient, clientSettings.getPingInterval());
             isConnected = true;
         } catch (Exception e) {
             isConnected = false;
@@ -120,7 +120,7 @@ public class TikTokWebSocketClient implements LiveSocketClient {
                     proxySettings.remove();
                 continue;
             }
-            pingingTask.run(webSocketClient, clientSettings.getPingInterval());
+            heartbeatTask.run(webSocketClient, clientSettings.getPingInterval());
             isConnected = true;
             break;
         }
@@ -141,7 +141,7 @@ public class TikTokWebSocketClient implements LiveSocketClient {
     public void stop() {
         if (isConnected && webSocketClient != null && webSocketClient.isOpen()) {
             webSocketClient.closeConnection(0, "");
-            pingingTask.stop();
+            heartbeatTask.stop();
         }
         webSocketClient = null;
         isConnected = false;

Client/src/main/java/io/github/jwdeveloper/tiktok/websocket/WebSocketHeartbeatTask.java

@@ -22,18 +22,19 @@
  */
 package io.github.jwdeveloper.tiktok.websocket;
 
-import io.github.jwdeveloper.tiktok.live.LiveEventsHandler;
 import org.java_websocket.WebSocket;
 
-public class TikTokWebSocketPingingTask {
+public class WebSocketHeartbeatTask
+{
     private Thread thread;
     private boolean isRunning = false;
     private final int MAX_TIMEOUT = 250;
     private final int SLEEP_TIME = 500;
+    private final byte[] heartbeatBytes = {58, 2, 104, 98}; // Byte Array of "3A026862" which is TikTok's custom heartbeat value
 
     public void run(WebSocket webSocket, long pingTaskTime) {
         stop();
-        thread = new Thread(() -> pingTask(webSocket, pingTaskTime), "pinging-task");
+        thread = new Thread(() -> heartbeatTask(webSocket, pingTaskTime), "heartbeat-task");
         isRunning = true;
         thread.start();
     }
@@ -44,11 +45,11 @@ public class TikTokWebSocketPingingTask {
         isRunning = false;
     }
 
-    private void pingTask(WebSocket webSocket, long pingTaskTime) {
+    private void heartbeatTask(WebSocket webSocket, long pingTaskTime) {
         while (isRunning) {
             try {
                 if (webSocket.isOpen()) {
-                    webSocket.sendPing();
+                    webSocket.send(heartbeatBytes);
                     Thread.sleep(pingTaskTime + (int) (Math.random() * MAX_TIMEOUT));
                 } else
                     Thread.sleep(SLEEP_TIME);

examples/pom.xml

@@ -41,7 +41,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>

extension-collector/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
         <artifactId>TikTokLiveJava</artifactId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
 
 
@@ -33,7 +33,7 @@
         <dependency>
             <groupId>io.github.jwdeveloper.tiktok</groupId>
             <artifactId>API</artifactId>
-            <version>1.8.2-Release</version>
+            <version>1.8.4-Release</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>

extension-recorder/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>extension-recorder</artifactId>

pom.xml

@@ -7,7 +7,7 @@
     <groupId>io.github.jwdeveloper.tiktok</groupId>
     <artifactId>TikTokLiveJava</artifactId>
     <packaging>pom</packaging>
-    <version>1.8.2-Release</version>
+    <version>1.8.4-Release</version>
     <modules>
         <module>API</module>
         <module>Client</module>

tools-readme/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <artifactId>TikTokLiveJava</artifactId>
         <groupId>io.github.jwdeveloper.tiktok</groupId>
-        <version>1.8.2-Release</version>
+        <version>1.8.4-Release</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>