LiveClientSettings

Signature

@Data
public class LiveClientSettings

Fields

• apiKey (String, getter, setter) — Optional: API Key for increased limit to signing server
• clientLanguage (String, getter, setter) — ISO-Language for Client
• fetchGifts (boolean, getter, setter) = false — Fetch and download gifts data before TikTokLive starts Note: Defaults to false - If false, client.giftManager() does not contain initial gifts
• hostName (String, getter, setter) — Optional: Use it if you need to change TikTok live hostname in builder
• httpSettings (HttpClientSettings, getter, setter) — Parameters used in requests to TikTok api
• logLevel (Level, getter, setter) — LoggingLevel for Logs
• offline (boolean, getter, setter) — Sets client to offline mode, prohibits connection to TikTok servers Note: Useful when testing client with custom events
• pingInterval (long, getter, setter) = 10000 — Interval of time in milliseconds between pings to TikTok Note: Min: 250 (0.25 seconds), Default: 10000 (10 seconds - TikTok Default)
• printToConsole (boolean, getter, setter) = true — Whether to print Logs to Console
• retryConnectionTimeout (Duration, getter, setter) — Before retrying connect, wait for select amount of time
• retryOnConnectionFailure (boolean, getter, setter) — Whether to Retry if Connection Fails
• roomId (String, getter, setter) — Optional: By default roomID is fetched before connect to live, but you can set it manually
• sessionId (String, getter, setter) — Optional: Sometimes not every messages from chat are send to TikTokLiveJava to fix this issue you can set sessionId. This requires ttTargetIdc also being set correctly for sessionid to be effective. Note: This cookie is supplied by TikTok and can be found in your browser cookies.
• throwOnAgeRestriction (boolean, getter, setter) — Throw an exception on 18+ Age Restriction
• ttTargetIdc (String, getter, setter) — Used with sessionId to verify it is valid and return extra chat messages and 18+ content. Note: This cookie is supplied by TikTok and can be found in your browser cookies.
• useEulerstreamEnterprise (boolean, getter, setter) — Use Eulerstream.com enterprise endpoints Note: Requires API Key with
• useEulerstreamWebsocket (boolean, getter, setter) — Use Eulerstream.com websocket for events Note: Requires API Key

Constructors

• Lombok @Data generates a constructor taking the final and @NonNull fields.

Methods

DefaultClientParams

public static Map<String, Object> DefaultClientParams()

Default Parameters for HTTP-Request

Returns

Map<String, Object>

DefaultRequestHeaders

public static Map<String, String> DefaultRequestHeaders()

Default Headers for HTTP-Request

Returns

Map<String, String>

createDefault

public static LiveClientSettings createDefault()

Returns

LiveClientSettings

Source

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