Skip to main content

Sources

Struct Sources 

Source
pub struct Sources<'a> { /* private fields */ }
Expand description

API functions related to sources.

Implementations§

Source§

impl Sources<'_>

Source

pub async fn active(&self, source: SourceId<'_>) -> Result<SourceActive>

Gets the active and show state of a source.

Source

pub async fn take_screenshot( &self, settings: TakeScreenshot<'_>, ) -> Result<String>

Gets a Base64-encoded screenshot of a source.

The TakeScreenshot::width and TakeScreenshot::height parameters are treated as “scale to inner”, meaning the smallest ratio will be used and the aspect ratio of the original resolution is kept. If TakeScreenshot::width and TakeScreenshot::height are not specified, the compressed image will use the full resolution of the source.

Source

pub async fn save_screenshot(&self, settings: SaveScreenshot<'_>) -> Result<()>

Saves a screenshot of a source to the file system.

The SaveScreenshot::width and SaveScreenshot::height parameters are treated as “scale to inner”, meaning the smallest ratio will be used and the aspect ratio of the original resolution is kept. If SaveScreenshot::width and SaveScreenshot::height are not specified, the compressed image will use the full resolution of the source.

Auto Trait Implementations§

§

impl<'a> Freeze for Sources<'a>

§

impl<'a> !RefUnwindSafe for Sources<'a>

§

impl<'a> Send for Sources<'a>

§

impl<'a> Sync for Sources<'a>

§

impl<'a> Unpin for Sources<'a>

§

impl<'a> UnsafeUnpin for Sources<'a>

§

impl<'a> !UnwindSafe for Sources<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more