opensubsonic 0.3.0

Complete async Rust client for the OpenSubsonic/Subsonic REST API
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
88
89
90
91
92
93
94
95

//! Jukebox API endpoint.

use crate::Client;
use crate::data::{JukeboxPlaylist, JukeboxStatus};
use crate::error::Error;

/// Jukebox control action.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum JukeboxAction {
    Get,
    Status,
    Set,
    Start,
    Stop,
    Skip,
    Add,
    Clear,
    Remove,
    Shuffle,
    SetGain,
}

impl JukeboxAction {
    fn as_str(self) -> &'static str {
        match self {
            Self::Get => "get",
            Self::Status => "status",
            Self::Set => "set",
            Self::Start => "start",
            Self::Stop => "stop",
            Self::Skip => "skip",
            Self::Add => "add",
            Self::Clear => "clear",
            Self::Remove => "remove",
            Self::Shuffle => "shuffle",
            Self::SetGain => "setGain",
        }
    }
}

/// Jukebox control result — either a status or a full playlist.
#[derive(Debug, Clone, PartialEq)]
pub enum JukeboxResult {
    /// Returned for most actions.
    Status(JukeboxStatus),
    /// Returned for the `get` action.
    Playlist(JukeboxPlaylist),
}

impl Client {
    /// Control the jukebox (server-side playback).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/jukeboxcontrol/>
    pub async fn jukebox_control(
        &self,
        action: JukeboxAction,
        index: Option<i32>,
        offset: Option<i32>,
        ids: &[&str],
        gain: Option<f64>,
    ) -> Result<JukeboxResult, Error> {
        let mut params = vec![("action", action.as_str().to_string())];
        if let Some(idx) = index {
            params.push(("index", idx.to_string()));
        }
        if let Some(off) = offset {
            params.push(("offset", off.to_string()));
        }
        for id in ids {
            params.push(("id", id.to_string()));
        }
        if let Some(g) = gain {
            params.push(("gain", g.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        let data = self.get_response("jukeboxControl", &param_refs).await?;

        // The "get" action returns jukeboxPlaylist; all others return jukeboxStatus.
        if action == JukeboxAction::Get {
            let playlist = data
                .get("jukeboxPlaylist")
                .ok_or_else(|| Error::Parse("Missing 'jukeboxPlaylist' in response".into()))?;
            Ok(JukeboxResult::Playlist(serde_json::from_value(
                playlist.clone(),
            )?))
        } else {
            let status = data
                .get("jukeboxStatus")
                .ok_or_else(|| Error::Parse("Missing 'jukeboxStatus' in response".into()))?;
            Ok(JukeboxResult::Status(serde_json::from_value(
                status.clone(),
            )?))
        }
    }
}