Skip to content

how_it_works.md

Latest commit

 

History

History
31 lines (23 loc) · 1.06 KB

how_it_works.md

File metadata and controls

31 lines (23 loc) · 1.06 KB

How libobs-rs Works

libobs-rs is a set of crates that provide safe Rust bindings to the OBS Studio C API (libobs).

Architecture

1. libobs (sys crate)

  • Raw FFI bindings to obs.dll.
  • Generated using bindgen.
  • Unsafe and difficult to use directly.

2. libobs-wrapper

  • Safe wrapper around libobs.
  • Handles memory management, threading, and context.
  • Provides a more Rust-idiomatic API.

3. libobs-simple

  • High-level abstraction.
  • Simplifies common tasks like recording and streaming.
  • Integrates libobs-bootstrapper for easy setup.

4. libobs-bootstrapper

  • Handles downloading and extracting OBS binaries.
  • Manages versioning and updates.

Data Flow

  1. Initialization: libobs-bootstrapper ensures binaries exist. libobs-wrapper loads obs.dll and initializes the core context.
  2. Configuration: You create scenes, sources, and encoders using libobs-simple or libobs-wrapper.
  3. Execution: libobs runs the video/audio pipeline in background threads.
  4. Output: Encoded data is written to file or stream.