librecast 1.0.0

Rust bindings for the librecast library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# Rust bindings to the librecast C library via `librecast-sys`

[![Stability: Active](https://masterminds.github.io/stability/active.svg)](https://masterminds.github.io/stability/active.html)
[![Crates.io](https://img.shields.io/crates/v/librecast)](https://crates.io/crates/librecast)
[![Docs.rs](https://docs.rs/librecast/badge.svg)](https://docs.rs/librecast)

## Usage

To use `librecast`, run `cargo add librecast` like normal, then use it like so:

```rust
use librecast::Librecast;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a new librecast context
    let librecast = Librecast::new()?;

    // Create a channel using the builder pattern
    let channel = librecast.channel_builder()
        .channel_builder()
        .name("test_channel")
        //.enable_rapterq()
        .build()?;

    // Join the channel
    channel.join()?;

    // Send a message
    let message = b"Hello, world!";
    channel.send(message)?;

    // Leave the channel
    channel.leave()?;

    Ok(())
}
```

## Examples

Run this first to start a receiver that listens for messages:

```bash
cargo run --example receiver
```

Then run this to send messages to the receiver, in a separate terminal:

```bash
cargo run --example sender
```

## License

This project is licensed under the [GPL-2.0-only](https://spdx.org/licenses/GPL-2.0-only.html) or
[GPL-3.0-only](https://spdx.org/licenses/GPL-3.0-only.html) license, at your option.