Struct WindowCaptureSourceUpdater

pub struct WindowCaptureSourceUpdater<'a> { /* private fields */ }

Used to update the source this updater was created from. For more details look at docs for the corresponding builder.

Implementations

impl<'a> WindowCaptureSourceUpdater<'a>

pub fn set_capture_method(self, capture_method: ObsWindowCaptureMethod) -> Self

Sets the capture method for the window capture

pub fn set_priority(self, priority: ObsWindowPriority) -> Self

Sets the priority of the window capture source. Used to determine in which order windows are searched for.

Arguments

• priority - The priority of the window capture source.

Returns

The updated WindowCaptureSourceBuilder instance.

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

Sets the window to capture.

Arguments

• window - The window to capture, represented as ObsString. Must be in the format of an obs window id

Returns

The updated WindowCaptureSourceBuilder instance.

pub fn set_cursor(self, cursor: bool) -> Self

Sets whether the cursor should be captured

pub fn set_capture_audio(self, capture_audio: bool) -> Self

Whether to capture audio from window source (BETA)
When enabled, creates an “Application Audio Capture” source that automatically updates to the currently captured window/application.
Note that if Desktop Audio is configured, this could result in doubled audio.

pub fn set_force_sdr(self, force_sdr: bool) -> Self

Whether to force SDR color space for the window capture source.

pub fn set_client_area(self, client_area: bool) -> Self

Whether to capture the window’s client area only (without borders, title bar and the main menu bar).

pub fn set_compatibility(self, compatibility: bool) -> Self

impl<'a> WindowCaptureSourceUpdater<'a>

pub fn get_windows(mode: WindowSearchMode) -> Result<Vec<WindowInfo>>

Gets a list of windows that can be captured by this source.

pub fn set_window(self, window: &WindowInfo) -> Self

Sets the window to capture.

Arguments

• window - The window to capture. A list of available windows can be retrieved using WindowCaptureSourceBuilder::get_windows

Returns

The updated WindowCaptureSourceBuilder instance.

Trait Implementations

impl<'a> ObsObjectUpdater<'a> for WindowCaptureSourceUpdater<'a>

type ToUpdate = ObsSourceRef

fn create_update<'async_trait>( runtime: ObsRuntime, updatable: &'a mut Self::ToUpdate, ) -> Pin<Box<dyn Future<Output = Result<Self, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

fn get_settings(&self) -> &ObsData

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

fn get_id() -> ObsString

Returns the ID of the object

fn update<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<(), ObsError>> + Send + 'async_trait>>

where Self: 'async_trait,