Struct WindowCaptureSource 

pub struct WindowCaptureSource { /* private fields */ }

Available on Windows only.

This struct is essentially a wrapper around an OBS source with additional functionality specific to the custom source.

It provides methods to create an updater and access source-specific signals.

Implementations

impl WindowCaptureSource

pub fn create_updater<'a>( &'a mut self, ) -> Result<WindowCaptureSourceUpdater<'a>, ObsError>

impl WindowCaptureSource

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 WindowCaptureSource

fn clone(&self) -> WindowCaptureSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowCaptureSource

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

Formats the value using the given formatter.

impl ObsHookableSourceTrait for WindowCaptureSource

fn source_specific_signals(&self) -> Arc<ObsHookableSourceSignals>

impl ObsObjectTrait<*mut obs_source> for WindowCaptureSource

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>

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>(&'a mut self) -> Result<T, ObsError>

where T: ObsObjectUpdater<'a, K, ToUpdate = Self> + Send + Sync, Self: Sized + Send + Sync,

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

impl ObsSourceTrait for WindowCaptureSource

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

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

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