
[TikTok-Live-Java](https://github.com/jwdeveloper/TikTok-Live-Java) is a Java library for connecting to TikTok LIVE streams.
It provides a fluent builder API with chainable event listeners.

<Callout type="info">
  View the full source on [GitHub](https://github.com/jwdeveloper/TikTok-Live-Java).
</Callout>

## Quickstart

<Steps>
<Step>

### Add the dependency

<Tabs items={['Maven', 'Gradle']}>
  <Tab value="Maven">
  ```xml
  <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>1.11.0-Release</version>
    </dependency>
  </dependencies>
  ```
  </Tab>
  <Tab value="Gradle">
  ```groovy
  repositories {
      mavenCentral()
      maven { url 'https://jitpack.io' }
  }

  dependencies {
      implementation 'com.github.jwdeveloper.TikTok-Live-Java:Client:1.11.0-Release'
  }
  ```
  </Tab>
</Tabs>

</Step>
<Step>

### Configure your API key

```java
TikTokLive.newClient("username")
    .configure(settings -> {
        settings.setApiKey("YOUR_API_KEY");
    })
```

</Step>
<Step>

### Connect and listen to events

```java
TikTokLive.newClient("username")
    .configure(settings -> {
        settings.setApiKey("YOUR_API_KEY");
    })
    .onConnected((liveClient, event) -> {
        System.out.println("Connected to live");
    })
    .onComment((liveClient, event) -> {
        System.out.println(event.getUser().getName() + ": " + event.getText());
    })
    .onGift((liveClient, event) -> {
        System.out.println(event.getUser().getProfileName()
            + " sends " + event.getGift().getName());
    })
    .onError((liveClient, event) -> {
        System.out.println("Error: " + event.getException().getMessage());
    })
    .buildAndConnect();
```

</Step>
</Steps>

## Common Events

| Method | Description |
|--------|-------------|
| `.onComment()` | A viewer sent a chat message |
| `.onGift()` | A viewer sent a gift |
| `.onLike()` | A viewer liked the stream |
| `.onConnected()` | Successfully connected |
| `.onError()` | An error occurred |
| `.onRoomInfo()` | Room info updated |

See the [API Key Usage](/docs/api-key-usage/java) guide for more configuration options.
