#screen-recording #recording #obs

macro libobs-source-macro

Helper macro for libobs-sources

2 releases

0.1.1 Sep 18, 2024
0.1.0 Aug 5, 2024

#537 in Video


Used in libobs-sources

GPL-3.0 license

15KB
215 lines

libOBS source macro

This is a helper macro for the libOBS sources crate.

Usage

This is an example for the window_capture source:

#[obs_source_builder("window_capture")]
pub struct WindowCaptureSourceBuilder {
    #[obs_property(type_t = "enum")]
    capture_method: ObsWindowCaptureMethod,

    // This attribute has to be on each field that should change any obs data setting.
    // notice the `settings_key` attribute, which sets the key that should be used when setting obs data (so data.set_string("window", 'your_window') would be called). Otherwise defaults to the field name.
    // The `type_t` attribute is the type that should be used in the obs data. This is used to generate the correct obs data setter.
    // Can be enum,enum_string,int,bool,string
    #[obs_property(type_t = "string", settings_key = "window")]
    window_raw: String,

    #[obs_property(type_t = "bool")]
    cursor: bool,
}

For more examples look at the libOBS sources crate.

Dependencies

~0.3–0.8MB
~18K SLoC