Skip to main content

Stream

Struct Stream 

Source
pub struct Stream(/* private fields */);
Expand description

An open stream; dropping it closes it.

Implementations§

Source§

impl Stream

Source

pub fn open(url: &str) -> Option<Stream>

A stream from an https URL, not playing yet. None if refused (refusal says why).

Source

pub fn play(&self)

Source

pub fn pause(&self)

Source

pub fn set_volume(&self, gain: f32)

0 to 1, applied smoothly.

Source

pub fn set_lowpass(&self, hz: f32)

A low-pass filter at hz (0: off), where Caps::lowpass.

Source

pub fn caps(&self) -> Caps

Source

pub fn state(&self) -> State

Source

pub fn error(&self) -> String

Why it failed (“” if it didn’t).

Source

pub fn position(&self) -> f64

Seconds played.

Source

pub fn duration(&self) -> Option<f64>

A track’s length in seconds; None for live streams and while unknown.

Source

pub fn metadata_version(&self) -> u32

Changes whenever the metadata does: read Stream::metadata only then.

Source

pub fn metadata_json(&self) -> String

The metadata as the runner gives it (JSON).

Source

pub fn metadata(&self) -> Metadata

Trait Implementations§

Source§

impl Debug for Stream

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for Stream

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

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, 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.