sonor 2.0.0

a library for controlling sonos speakers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use crate::{track::TrackInfo, Result, Speaker};
use futures_util::future::{try_join, try_join4};

/// A Snapshot of the state the speaker is in right now.
/// Useful for announcing some clip at a lower volume, then later resume where you left off.
/// The struct is obtained by calling the [snapshot](struct.Speaker.html#method.snapshot)-method on a speaker and applied using [Speaker::apply](struct.Speaker.html#method.apply).
#[derive(Debug, Default)]
pub struct Snapshot {
    volume: Option<u16>,
    is_playing: Option<bool>,
    track_info: Option<TrackInfo>,

    transport_uri: Option<String>,
}

impl Snapshot {
    /// Sets the volume of the snapshot
    pub fn set_volume(&mut self, volume: u16) -> &mut Self {
        self.volume = Some(volume);
        self
    }

    /// Sets whether the speaker is playing
    pub fn set_is_playing(&mut self, is_playing: bool) -> &mut Self {
        self.is_playing = Some(is_playing);
        self
    }

    /// Specifies the current track info
    pub fn set_track_info(&mut self, track_info: TrackInfo) -> &mut Self {
        self.track_info = Some(track_info);
        self
    }

    /// Specifies the current track info
    pub fn set_transport_uri(&mut self, transport_uri: impl Into<String>) -> &mut Self {
        self.transport_uri = Some(transport_uri.into());
        self
    }

    pub(crate) async fn from_speaker(speaker: &Speaker) -> Result<Self> {
        let (volume, track_info, is_playing, transport_uri) = try_join4(
            speaker.volume(),
            speaker.track(),
            speaker.is_playing(),
            speaker.transport_uri(),
        )
        .await?;

        Ok(Self {
            volume: Some(volume),
            track_info,
            is_playing: Some(is_playing),
            transport_uri,
        })
    }

    pub(crate) async fn apply(&self, speaker: &Speaker) -> Result<()> {
        if let Some(volume) = self.volume {
            speaker.set_volume(volume).await?;
        }

        match &self.transport_uri {
            Some(uri) if uri.starts_with("x-sonos-vli") => {
                log::warn!("unsupported transport uri: 'x-sonos-vli:...'")
            }
            Some(uri) => speaker.set_transport_uri(uri, "").await?,
            None => {}
        }

        if let Some(track_info) = &self.track_info {
            try_join(
                speaker.seek_track(track_info.track_no()),
                speaker.skip_to(track_info.elapsed()),
            )
            .await?;
        }

        match self.is_playing {
            Some(false) => speaker.pause().await?,
            Some(true) => speaker.play().await?,
            None => {}
        }

        Ok(())
    }
}