vtubestudio-rs
A library for interacting with the VTube Studio API.
Basic usage
This example creates a Client using the provided builder, which:
- connects to
ws://localhost:8001usingtokio_tungstenite - authenticates with an existing token (if present and valid)
- reconnects when disconnected, and retries the failed request on reconnection success
- requests a new auth token on receiving an auth error, and retries the initial failed request on authentication success
use vtubestudio::{Client, Error};
use vtubestudio::data::StatisticsRequest;
#[tokio::main]
async fn main() -> Result<(), Error> {
// An auth token from a previous successful authentication request
let stored_token = Some("...".to_string());
let (mut client, mut new_tokens) = Client::builder()
.auth_token(stored_token)
.authentication("Plugin name", "Developer name", None)
.build_tungstenite();
tokio::spawn(async move {
// This returns whenever the authentication middleware receives a new auth token.
// We can handle it by saving it somewhere, etc.
while let Some(token) = new_tokens.next().await {
println!("Got new auth token: {}", token);
}
});
// Use the client to send a `StatisticsRequest`, handling authentication if necessary.
// The return type is inferred from the input type to be `StatisticsResponse`.
let resp = client.send(&StatisticsRequest {}).await?;
println!("VTube Studio has been running for {}ms", resp.uptime);
Ok(())
}
For more details, please check the documentation on docs.rs.
14 Jun 8, 2023
2 Jul 10, 2023
5 Nov 11, 2021
2 May 6, 2022
20 Aug 3, 2022
5 Jun 21, 2022
9 Dec 25, 2022
35 Nov 21, 2022
11 Dec 27, 2022
4 Aug 13, 2022
9 Dec 17, 2022
4 Dec 29, 2022
12 Jan 22, 2023
4 Jun 12, 2023
8 Jul 17, 2023
3 Feb 28, 2024
4 Aug 30, 2022
4 Jun 8, 2022
7 Dec 28, 2022