Struct PipeWireScreenCaptureSourceBuilder 

pub struct PipeWireScreenCaptureSourceBuilder { /* private fields */ }

Available on Linux only.

This struct is used to build a PipeWire screen capture source (so window + desktop capture).

Implementations

impl PipeWireScreenCaptureSourceBuilder

pub fn set_restore_token<T: Into<ObsString> + Sync + Send>( self, restore_token: T, ) -> Self

Restore token for reconnecting to previous sessions

pub fn set_show_cursor(self, show_cursor: bool) -> Self

Whether to show cursor (for screen capture)

Trait Implementations

impl ObsObjectBuilder for PipeWireScreenCaptureSourceBuilder

fn new<T: Into<ObsString> + Send + Sync>( name: T, runtime: ObsRuntime, ) -> Result<Self, ObsError>

fn runtime(&self) -> &ObsRuntime

fn get_settings(&self) -> &ObsData

fn get_settings_updater(&mut self) -> &mut ObsDataUpdater

fn get_hotkeys(&self) -> &ObsData

fn get_hotkeys_updater(&mut self) -> &mut ObsDataUpdater

fn get_name(&self) -> ObsString

Returns the name of the source.

fn get_id() -> ObsString

Returns the ID of the source.

fn object_build(self) -> Result<ObjectInfo, ObsError>

impl ObsSourceBuilder for PipeWireScreenCaptureSourceBuilder

type T = ObsPipeWireSourceRef

fn build(self) -> Result<Self::T, ObsError>

where Self: Sized,

fn add_to_scene( self, scene: &mut ObsSceneRef, ) -> Result<ObsSceneItemRef<Self::T>, ObsError>

where Self: Sized,

Both items are returned: the source and the scene item it was added as. You can safely drop these items, they are stored within the scene if you don’t need them.