pub struct PipeWireScreenCaptureSourceBuilder { /* private fields */ }Available on Linux only.
Expand description
This struct is used to build a PipeWire screen capture source (so window + desktop capture).
Implementations§
Source§impl PipeWireScreenCaptureSourceBuilder
impl PipeWireScreenCaptureSourceBuilder
Sourcepub fn set_restore_token<T: Into<ObsString> + Sync + Send>(
self,
restore_token: T,
) -> Self
pub fn set_restore_token<T: Into<ObsString> + Sync + Send>( self, restore_token: T, ) -> Self
Restore token for reconnecting to previous sessions
Sourcepub fn set_show_cursor(self, show_cursor: bool) -> Self
pub fn set_show_cursor(self, show_cursor: bool) -> Self
Whether to show cursor (for screen capture)
Sourcepub fn set_connect_node(self, connect_node: i64) -> Self
pub fn set_connect_node(self, connect_node: i64) -> Self
Existing PipeWire node id to capture directly. A value greater than zero can bypass
the desktop portal picker when the loaded linux-pipewire plugin supports the
ConnectNode extension. Zero keeps the normal portal flow.
Trait Implementations§
Source§impl ObsObjectBuilder for PipeWireScreenCaptureSourceBuilder
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 object_build(self) -> Result<ObjectInfo, ObsError>
Source§impl ObsSourceBuilder for PipeWireScreenCaptureSourceBuilder
impl ObsSourceBuilder for PipeWireScreenCaptureSourceBuilder
type T = ObsPipeWireSourceRef
fn build(self) -> Result<Self::T, ObsError>where
Self: Sized,
Source§fn add_to_scene(
self,
scene: &mut ObsSceneRef,
) -> Result<ObsSceneItemRef<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.
Auto Trait Implementations§
impl !RefUnwindSafe for PipeWireScreenCaptureSourceBuilder
impl !UnwindSafe for PipeWireScreenCaptureSourceBuilder
impl Forget for PipeWireScreenCaptureSourceBuilder
impl Freeze for PipeWireScreenCaptureSourceBuilder
impl Move for PipeWireScreenCaptureSourceBuilder
impl Send for PipeWireScreenCaptureSourceBuilder
impl Sync for PipeWireScreenCaptureSourceBuilder
impl Unpin for PipeWireScreenCaptureSourceBuilder
impl UnsafeUnpin for PipeWireScreenCaptureSourceBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more