Struct ObsPipeWireSourceRef 

pub struct ObsPipeWireSourceRef { /* private fields */ }

Available on Linux only.

General PipeWire source reference wrapper, which has a restore_token

Implementations

impl ObsPipeWireSourceRef

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>()?;

impl ObsPipeWireSourceRef

pub fn new( source: ObsSourceRef, source_type: ObsPipeWireSourceType, ) -> Result<Self, ObsError>

Creates a new ObsPipeWireSourceRef from an ObsSourceRef.

pub fn get_restore_token(&self) -> Result<Option<String>, ObsError>

Gets the restore token used for reconnecting to previous sessions for pipewire-desktop-capture-source and pipewire-window-capture-source sources.

As of right now, there is no callback or signal to notify when the token has been set, you have to call this method to get the restore token.

The restore token will most probably be of Some(String) after the user has selected a screen or window to capture.

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

pub fn get_source_type(&self) -> ObsPipeWireSourceType

Trait Implementations

impl Clone for ObsPipeWireSourceRef

fn clone(&self) -> ObsPipeWireSourceRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObsPipeWireSourceRef

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

Formats the value using the given formatter.

impl ObsObjectTrait<*mut obs_source> for ObsPipeWireSourceRef

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 ObsPipeWireSourceRef

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

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

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