Struct portal_screencast::ScreenCast

pub struct ScreenCast { /* fields omitted */ }

An un-opened screencast session. This can be queried fro the supported capture source types, and used to configure which source types to prompt for. Each ScreenCast can be mde active once by calling start().

Implementations

impl ScreenCast

pub fn new() -> Result<Self, PortalError>

Create a new ScreenCast Session

Connects to D-Bus and initaialises a ScreenCast object.

pub fn source_types(&self) -> Result<SourceType, PortalError>

Get the supported source types for this connection

pub fn set_source_types(&mut self, types: SourceType)

Set the source types to capture. This should be a subset of those from source_types().

pub fn enable_multiple(&mut self)

Enable multi-stream selection. This allows the user to choose more than one thing to share. Each will be a separate item in the ActiveScreenCast::streams() iterator.

pub fn start(
    self,
    parent_window: Option<&str>
) -> Result<ActiveScreenCast, PortalError>

Try to start the screen cast. This will prompt the user to select a source to share.