Struct GameCaptureSourceBuilder

pub struct GameCaptureSourceBuilder { /* private fields */ }

Implementations

impl GameCaptureSourceBuilder

pub fn set_capture_mode(self, capture_mode: ObsGameCaptureMode) -> Self

Sets the capture mode for the game capture source. Look at doc for ObsGameCaptureMode

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_priority(self, priority: ObsWindowPriority) -> Self

Window Match Priority

pub fn set_sli_compatability(self, sli_compatability: bool) -> Self

SLI/Crossfire Capture Mode (Slow)

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

Whether the cursor should be captured

pub fn set_allow_transparency(self, allow_transparency: bool) -> Self

If transparency of windows should be allowed

pub fn set_premultiplied_alpha(self, premultiplied_alpha: bool) -> Self

Premultiplied Alpha

pub fn set_limit_framerate(self, limit_framerate: bool) -> Self

Limit capture framerate

pub fn set_capture_overlays(self, capture_overlays: bool) -> Self

Capture third party overlays (such as steam overlays)

pub fn set_anti_cheat_hook(self, anti_cheat_hook: bool) -> Self

Use anti-cheat compatibility hook

pub fn set_hook_rate(self, hook_rate: ObsHookRate) -> Self

Hook rate (Ranging from slow to fastest)

pub fn set_rgb10a2_space(self, rgb10a2_space: ObsGameCaptureRgbaSpace) -> Self

The color space to capture in

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.

impl GameCaptureSourceBuilder

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 GameCaptureSourceBuilder::get_windows

Returns

The updated GameCaptureSourceBuilder instance.

Trait Implementations

impl Debug for GameCaptureSourceBuilder

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

Formats the value using the given formatter.

impl ObsObjectBuilder for GameCaptureSourceBuilder

fn new<'async_trait, T>( name: T, runtime: ObsRuntime, ) -> Pin<Box<dyn Future<Output = Result<Self, ObsError>> + Send + 'async_trait>>

where T: 'async_trait + Into<ObsString> + Send + Sync, Self: 'async_trait,

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 build<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<ObjectInfo, ObsError>> + Send + 'async_trait>>

where Self: 'async_trait,