Struct MediaTransportProps 

pub struct MediaTransportProps {

    pub title: String,
    pub subtitle: Option<String>,
    pub error: bool,
    pub art: Option<PictureSource>,
    pub art_name: Option<String>,
    pub opens: Option<String>,
    pub playing: bool,
    pub idle: bool,
    pub position: Option<f64>,
    pub duration: Option<f64>,
    pub volume: Option<f64>,
    pub shuffle: Option<bool>,
    pub repeat: Option<TransportRepeat>,
    pub liked: Option<bool>,
    pub lyrics: Option<bool>,
    pub queue: Option<bool>,
    pub act_play_pause: Event,
    pub act_previous: Event,
    pub act_next: Event,
    pub act_shuffle: Event,
    pub act_repeat: Event,
    pub act_like: Event,
    pub act_mute: Event,
    pub act_seek: Event,
    pub act_volume: Event,
    pub act_lyrics: Event,
    pub act_queue: Event,
}

What is playing and the controls that steer it, as one band: the art and the song, like and lyrics, shuffle, previous, play/pause, next and repeat over the scrubber, the queue and the volume. It stands across the window’s foot, under every column.

A control the view gives no event for is left out: an app that cannot shuffle shows no shuffle. A control the view leaves off changes what the band shows rather than what plays.

Fields

title: String

The song’s name, or what the band says with nothing playing.

subtitle: Option<String>

Who it is by, or why it cannot play.

error: bool

The subtitle says why it cannot play: it reads as an error.

art: Option<PictureSource>

Its cover: a picture by its address, loaded as it arrives. Without one the placeholder shows the album’s initials.

art_name: Option<String>

The name the placeholder cover takes its initials and colour from (the album).

opens: Option<String>

What a press on the art opens (“Open album”, “Show lyrics”), as it is announced.

playing: bool

Whether it plays.

idle: bool

Nothing can play: every control rests disabled.

position: Option<f64>

Where it is, in seconds.

duration: Option<f64>

How long it is, in seconds.

volume: Option<f64>

The volume, 0..=1; zero is muted.

shuffle: Option<bool>

Whether shuffle is on. Without it there is no shuffle control.

repeat: Option<TransportRepeat>

What repeat repeats. Without it there is no repeat control.

liked: Option<bool>

Whether what plays is liked. Without it there is no like control.

lyrics: Option<bool>

Whether the lyrics show. Without it there is no lyrics control.

queue: Option<bool>

Whether the queue shows. Without it there is no queue control.

act_play_pause: Event

The play/pause control was pressed.

act_previous: Event

The previous control was pressed.

act_next: Event

The next control was pressed.

act_shuffle: Event

Shuffle was toggled.

act_repeat: Event

Repeat was toggled.

act_like: Event

What plays was liked or unliked.

act_mute: Event

The band was muted or unmuted.

act_seek: Event

The band was moved to a place in the song: carries 0..=1.

act_volume: Event

The volume was set: carries 0..=1.

act_lyrics: Event

The lyrics were asked for.

act_queue: Event

The queue was asked for.

Implementations

impl MediaTransportProps

pub fn state(&self) -> TransportState

What the band shows, as the view declares it.

pub fn triggers(&self) -> TransportTriggers

What each control reports.

Trait Implementations

impl Component for MediaTransportProps

const NAME: &'static str = "MediaTransport"

The component’s name, as code calls it.

fn describe() -> Description

fn from_source(source: &mut dyn Source) -> Result<MediaTransportProps, Error>

The props source gives.

impl Default for MediaTransportProps

fn default() -> MediaTransportProps

Returns the “default value” for a type.