84 lines
3 KiB
Rust
84 lines
3 KiB
Rust
//! # OBSWS - The obws (obvious) remote control library for OBS
|
|
//!
|
|
//! Remote control OBS with the [obs-websocket] plugin from Rust 🦀.
|
|
//!
|
|
//! [obs-websocket]: https://github.com/Palakis/obs-websocket
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! ```no_run
|
|
//! 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", 4444).await?;
|
|
//!
|
|
//! /// Get and print out version information of OBS and obs-websocket.
|
|
//! let version = client.general().get_version().await?;
|
|
//! println!("{:#?}", version);
|
|
//!
|
|
//! /// Optionally log-in (if enabled in obs-websocket) to allow other APIs and receive events.
|
|
//! client.login(Some("password")).await?;
|
|
//!
|
|
//! /// Get a list of available scenes and print them out.
|
|
//! let scene_list = client.scenes().get_scene_list().await?;
|
|
//! println!("{:#?}", scene_list);
|
|
//!
|
|
//! Ok(())
|
|
//! }
|
|
//! ```
|
|
|
|
#![warn(missing_docs, rust_2018_idioms, clippy::all)]
|
|
|
|
pub use client::Client;
|
|
|
|
pub mod client;
|
|
pub mod common;
|
|
#[cfg(feature = "events")]
|
|
pub mod events;
|
|
pub mod requests;
|
|
pub mod responses;
|
|
|
|
mod de;
|
|
|
|
/// Result type used throughout the crate that uses [`Error`] as default error.
|
|
pub type Result<T, E = Error> = std::result::Result<T, E>;
|
|
|
|
/// Errors that can occur while using this crate.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
/// An error occured while trying to connect to the websocket.
|
|
#[error("failed to connect to the obs-websocket plugin")]
|
|
Connect(#[source] tokio_tungstenite::tungstenite::Error),
|
|
/// Failed to serialize the message to be send to the websocket.
|
|
#[error("failed to serialize message")]
|
|
SerializeMessage(#[source] serde_json::Error),
|
|
/// A message could not be send through the websocket.
|
|
#[error("failed to send message to the obs-websocket plugin")]
|
|
Send(#[source] tokio_tungstenite::tungstenite::Error),
|
|
/// Tried to receive data while the send side was already closed.
|
|
#[error("send side is closed")]
|
|
ReceiveMessage(#[source] tokio::sync::oneshot::error::RecvError),
|
|
/// Failed to deserialize the message that came back as response.
|
|
#[error("the response message could not be deserialized")]
|
|
DeserializeResponse(#[source] serde_json::Error),
|
|
/// Failed to serialize custom user defined data for a message.
|
|
#[error("failed to serialize custom data")]
|
|
SerializeCustomData(#[source] serde_json::Error),
|
|
/// An error returned from the obs-websocket API.
|
|
#[error("API error: {0}")]
|
|
Api(String),
|
|
/// The obs-websocket API requires authentication but no password was given.
|
|
#[error("authentication required but no password provided")]
|
|
NoPassword,
|
|
/// Unknown flags were found while trying to parse bitflags.
|
|
#[error("value {0} contains unknown flags")]
|
|
UnknownFlags(u8),
|
|
/// Tried to interact with obs-websocket while not connected (for example trying to get a new
|
|
/// event stream).
|
|
#[error("currently not connected to obs-websocket")]
|
|
Disconnected,
|
|
}
|