Struct leptos_use::UseDisplayMediaReturn

pub struct UseDisplayMediaReturn<StartFn, StopFn>
where
    StartFn: Fn() + Clone,
    StopFn: Fn() + Clone,
{
    pub stream: Signal<Option<Result<MediaStream, JsValue>>>,
    pub start: StartFn,
    pub stop: StopFn,
    pub enabled: Signal<bool>,
    pub set_enabled: WriteSignal<bool>,
}

Return type of use_display_media

Fields

stream: Signal<Option<Result<MediaStream, JsValue>>>

The current MediaStream if it exists. Initially this is None until start resolved successfully. In case the stream couldn’t be started, for example because the user didn’t grant permission, this has the value Some(Err(...)).

start: StartFn

Starts the screen streaming. Triggers the ask for permission if not already granted.

stop: StopFn

Stops the screen streaming

enabled: Signal<bool>

A value of true indicates that the returned MediaStream has resolved successfully and thus the stream is enabled.

set_enabled: WriteSignal<bool>

A value of true is the same as calling start() whereas false is the same as calling stop().

Trait Implementations

impl<StartFn, StopFn> Clone for UseDisplayMediaReturn<StartFn, StopFn>

where StartFn: Fn() + Clone + Clone, StopFn: Fn() + Clone + Clone,

fn clone(&self) -> UseDisplayMediaReturn<StartFn, StopFn>

Returns a copy of the value.

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

Performs copy-assignment from source.