
[TikTokLiveRust](https://github.com/jwdeveloper/TikTokLiveRust) is a Rust library for connecting to TikTok LIVE streams.
It provides an async, event-driven API built on Tokio.

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

## Quickstart

<Steps>
<Step>

### Add dependencies

Add to your `Cargo.toml`:

```toml
[dependencies]
tiktoklive = "0.0.19"
tokio = { version = "1.35.1", features = ["full"] }
log = "0.4"
env_logger = "0.10.1"
```

</Step>
<Step>

### Connect and listen to events

```rust
use tiktoklive::{
    core::live_client::TikTokLiveClient,
    data::live_common::TikTokLiveSettings,
    generated::events::TikTokLiveEvent,
    TikTokLive,
};

#[tokio::main]
async fn main() {
    let client = TikTokLive::new_client("username")
        .configure(|settings| {
            settings.sign_api_key = "YOUR_API_KEY".to_string();
        })
        .on_event(handle_event)
        .build();

    if let Err(e) = client.connect().await {
        eprintln!("Error: {}", e);
    }
}

fn handle_event(client: &TikTokLiveClient, event: &TikTokLiveEvent) {
    match event {
        TikTokLiveEvent::OnChat(e) => {
            println!("{}: {}", e.raw_data.user.nickname, e.raw_data.content);
        }
        TikTokLiveEvent::OnGift(e) => {
            println!("{} sent {} x{}",
                e.raw_data.user.nickname,
                e.raw_data.gift.name,
                e.raw_data.gift.combo
            );
        }
        TikTokLiveEvent::OnMember(e) => {
            println!("{} joined", e.raw_data.user.nickname);
        }
        _ => {}
    }
}
```

</Step>
</Steps>

## Common Events

| Event | Description |
|-------|-------------|
| `OnChat` | A viewer sent a chat message |
| `OnGift` | A viewer sent a gift |
| `OnMember` | A viewer joined the stream |
| `OnLike` | A viewer liked the stream |
| `OnConnected` | Successfully connected |
