Struct LinuxGeneralWindowCaptureBuilder 

pub struct LinuxGeneralWindowCaptureBuilder { /* private fields */ }

Available on Linux only.

Implementations

impl LinuxGeneralWindowCaptureBuilder

pub fn set_restore_token(self, token: &str) -> Self

Set the PipeWire restore token, which will be used to re-establish the same selection the user did previously.

Display Server

PipeWire only

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

Display Server

All supported display servers

pub fn set_capture_window(self, capture_window: &str) -> Self

Set the window to capture (window ID as string)

Display Server

XComposite (X11) only

pub fn set_cut_top(self, cut_top: i64) -> Self

Crop from top (in pixels)

Display Server

XComposite (X11) only

pub fn set_cut_left(self, cut_left: i64) -> Self

Crop from left (in pixels)

Display Server

XComposite (X11) only

pub fn set_cut_right(self, cut_right: i64) -> Self

Crop from right (in pixels)

Display Server

XComposite (X11) only

pub fn set_cut_bot(self, cut_bot: i64) -> Self

Crop from bottom (in pixels)

Display Server

XComposite (X11) only

pub fn set_include_border(self, include_border: bool) -> Self

Include window border/decorations

Display Server

XComposite (X11) only

pub fn set_exclude_alpha(self, exclude_alpha: bool) -> Self

Exclude alpha channel (disable transparency)

Display Server

XComposite (X11) only

Trait Implementations

impl ObsObjectBuilder for LinuxGeneralWindowCaptureBuilder

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

where Self: Sized,

fn runtime(&self) -> &ObsRuntime

fn get_name(&self) -> ObsString

Returns the name of the source.

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

where Self: Sized,

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_id() -> ObsString

Returns the ID of the source.

impl ObsSourceBuilder for LinuxGeneralWindowCaptureBuilder

type T = ObsEitherSource<XCompositeInputSource, 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.