Skip to main content

libobs_simple/
lib.rs

1#![cfg_attr(all(doc, not(doctest)), feature(doc_cfg))]
2//! Opinionated convenience workflows on top of `libobs-wrapper`.
3//!
4//! # Start here for common applications
5//!
6//! `libobs-simple` is the layer that **chooses sensible OBS implementations for you** while the
7//! underlying `libobs-wrapper` remains available for full control. Both layers use the same
8//! [`wrapper::context::ObsContext`].
9//!
10//! | Goal | Start with |
11//! | --- | --- |
12//! | Record to a file | [`output::simple`] |
13//! | Stream H.264/AAC to RTMP | [`output::streaming`] |
14//! | Replay buffer | [`output::replay`] |
15//! | Scene collection persistence/history | [`scene_collection`] |
16//! | Common window/monitor/platform sources | [`sources`] |
17//! | Anything more custom | [`wrapper`] |
18//!
19//! Recording and streaming builders discover the loaded OBS capabilities rather than assuming a
20//! particular NVENC/QSV/AMF/x264 backend. The simple layer delegates native lifetimes, dynamic
21//! settings validation, and output graph validation to [`wrapper`].
22//!
23//! Drop down to [`wrapper::capabilities`] and [`wrapper::settings`] for arbitrary plugins, or
24//! [`wrapper::scenes`] for groups/native ordering/full transform state. You do not need to create a
25//! second context to mix the two layers.
26
27pub mod error;
28pub mod output;
29pub mod scene_collection;
30pub mod sources;
31
32pub use error::ObsSimpleError;
33pub use libobs_wrapper as wrapper;