21 unstable releases

0.11.5 Sep 4, 2023
0.11.2 Jun 22, 2023
0.10.0 Nov 14, 2022
0.9.1 Feb 25, 2022
0.2.0 Dec 29, 2020

#30 in Video

Download history 212/week @ 2023-11-01 186/week @ 2023-11-08 244/week @ 2023-11-15 283/week @ 2023-11-22 312/week @ 2023-11-29 265/week @ 2023-12-06 263/week @ 2023-12-13 240/week @ 2023-12-20 188/week @ 2023-12-27 240/week @ 2024-01-03 545/week @ 2024-01-10 293/week @ 2024-01-17 264/week @ 2024-01-24 252/week @ 2024-01-31 332/week @ 2024-02-07 652/week @ 2024-02-14

1,523 downloads per month
Used in 3 crates

MIT license

285KB
6K SLoC

OBWS - The obws (obvious) remote control library for OBS

Build Status Repository Documentation Code Coverage

Remote control OBS with the obs-websocket plugin from Rust 🦀.

Usage

Add obws to your project with cargo add obws@0.11.5 or add it manually to your Cargo.toml:

[dependencies]
obws = "0.11.5"

In addition, you will need to use the latest tokio runtime to use this library as it makes heavy use of async/await and is bound to this runtime.

Example

Here we connect to a OBS instance, get some version information and log in to access the whole API and lastly print out a list of available scenes.

For more usage instructions see the docs or check out the examples.

use anyhow::Result;
use obws::Client;

#[tokio::main]
async fn main() -> Result<()> {
    // Connect to the OBS instance through obs-websocket.
    let client = Client::connect("localhost", 4455, Some("password")).await?;

    // Get and print out version information of OBS and obs-websocket.
    let version = client.general().version().await?;
    println!("{version:#?}");

    // Get a list of available scenes and print them out.
    let scene_list = client.scenes().list().await?;
    println!("{scene_list:#?}");

    Ok(())
}

License

This project is licensed under MIT License (or http://opensource.org/licenses/MIT).

Dependencies

~7–19MB
~214K SLoC