Struct ObsFilterRef 

pub struct ObsFilterRef { /* private fields */ }

Implementations

impl ObsFilterRef

pub fn new<T: Into<ObsString> + Sync + Send, K: Into<ObsString> + Sync + Send>( id: T, name: K, settings: Option<ImmutableObsData>, hotkey_data: Option<ImmutableObsData>, runtime: ObsRuntime, ) -> Result<Self, ObsError>

Creates a new OBS filter, this is a more advanced usage as you’ll have to specify the id, name, settings and hotkey_data yourself. This will be easier in the future…

impl ObsFilterRef

pub fn inner_source(&self) -> &ObsSourceRef

pub fn inner_source_mut(&mut self) -> &mut ObsSourceRef

pub fn into_inner_source(self) -> ObsSourceRef

Consumes self and returns the inner ObsSourceRef

You can still update this source (if created by libobs-simple) and create an updater like so:

let updater = my_custom_source.create_updater()?;

let source = my_custom_source.into_inner_source();
let updater = source.create_updater::<MyCustomSourceUpdater>()?;

Trait Implementations

impl Clone for ObsFilterRef

fn clone(&self) -> ObsFilterRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObsFilterRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ObsFilterRef

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObsObjectTrait<*mut obs_source> for ObsFilterRef

fn name(&self) -> ObsString

fn id(&self) -> ObsString

fn runtime(&self) -> &ObsRuntime

fn settings(&self) -> Result<ImmutableObsData, ObsError>

fn hotkey_data(&self) -> Result<ImmutableObsData, ObsError>

fn update_settings(&self, settings: ObsData) -> Result<(), ObsError>

Updates the settings of this output. Fails if active.

fn as_ptr(&self) -> SmartPointerSendable<*mut obs_source_t>

Creates a new reference to the drop guard. This is useful if you are using the underlying raw pointer, make sure to store it along the drop guard

fn create_updater<'a, T: ObsObjectUpdater<'a, K, ToUpdate = Self> + Send + Sync>( &'a mut self, ) -> Result<T, ObsError>

where Self: Sized + Send + Sync,

Updates the object with the current settings. For examples please take a look at the Github repository.

impl ObsSourceTrait for ObsFilterRef

fn signals(&self) -> &Arc<ObsSourceSignals>

fn get_active_filters(&self) -> Result<Vec<ObsFilterGuardPair>, ObsError>

fn apply_filter(&self, filter: &ObsFilterRef) -> Result<(), ObsError>

impl PartialEq for ObsFilterRef

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ObsFilterRef