Struct SCShareableContentOptions 

pub struct SCShareableContentOptions { /* private fields */ }

Implementations

impl SCShareableContentOptions

pub fn with_exclude_desktop_windows(self, exclude: bool) -> Self

Exclude desktop windows from the shareable content.

When set to true, desktop-level windows (like the desktop background) are excluded from the returned window list.

pub fn with_on_screen_windows_only(self, on_screen_only: bool) -> Self

Include only on-screen windows in the shareable content.

When set to true, only windows that are currently visible on screen are included. Minimized or off-screen windows are excluded.

pub fn exclude_desktop_windows(self, exclude: bool) -> Self

👎Deprecated since 1.5.0: Use with_exclude_desktop_windows() instead

Exclude desktop windows from the shareable content.

pub fn on_screen_windows_only(self, on_screen_only: bool) -> Self

👎Deprecated since 1.5.0: Use with_on_screen_windows_only() instead

Include only on-screen windows in the shareable content.

pub fn get(self) -> Result<SCShareableContent, SCError>

Get shareable content synchronously

This blocks until the content is retrieved.

Errors

Returns an error if screen recording permission is not granted or retrieval fails.

pub fn below_window( self, reference_window: &SCWindow, ) -> Result<SCShareableContent, SCError>

Get shareable content with only windows below a reference window

This returns windows that are stacked below the specified reference window in the window layering order.

Arguments

• reference_window - The window to use as the reference point

Errors

Returns an error if screen recording permission is not granted or retrieval fails.

pub fn above_window( self, reference_window: &SCWindow, ) -> Result<SCShareableContent, SCError>

Get shareable content with only windows above a reference window

This returns windows that are stacked above the specified reference window in the window layering order.

Arguments

• reference_window - The window to use as the reference point

Errors

Returns an error if screen recording permission is not granted or retrieval fails.

Trait Implementations

impl Clone for SCShareableContentOptions

fn clone(&self) -> SCShareableContentOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SCShareableContentOptions

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

Formats the value using the given formatter.

impl Default for SCShareableContentOptions

fn default() -> SCShareableContentOptions

Returns the “default value” for a type.

impl PartialEq for SCShareableContentOptions

fn eq(&self, other: &SCShareableContentOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SCShareableContentOptions

impl StructuralPartialEq for SCShareableContentOptions