Struct MonitorCaptureSourceBuilder 

pub struct MonitorCaptureSourceBuilder { /* private fields */ }

Available on Windows only.

Provides an easy-to-use builder for the monitor capture source.

Implementations

impl MonitorCaptureSourceBuilder

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

pub fn set_capture_cursor(self, capture_cursor: bool) -> Self

Sets whether the cursor should be captured.

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

Compatibility mode for the monitor capture source.

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

If the capture should force SDR

impl MonitorCaptureSourceBuilder

pub fn get_monitors() -> Result<Vec<Sendable<DisplayInfo>>, ObsSimpleError>

Gets all available monitors

pub fn set_monitor(self, monitor: &Sendable<DisplayInfo>) -> Self

impl MonitorCaptureSourceBuilder

pub fn set_capture_method(self, method: ObsDisplayCaptureMethod) -> Self

Sets the capture method for the monitor capture source. If you want to use DXGI, it is required for your application to be DPI aware.

Trait Implementations

impl Debug for MonitorCaptureSourceBuilder

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

Formats the value using the given formatter.

impl ObsObjectBuilder for MonitorCaptureSourceBuilder

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 MonitorCaptureSourceBuilder

type T = MonitorCaptureSource

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.