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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! Media Annotation API endpoints.

use crate::Client;
use crate::error::Error;

impl Client {
    /// Star songs, albums, or artists.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/star/>
    pub async fn star(
        &self,
        ids: &[&str],
        album_ids: &[&str],
        artist_ids: &[&str],
    ) -> Result<(), Error> {
        let mut params = Vec::new();
        for id in ids {
            params.push(("id", id.to_string()));
        }
        for id in album_ids {
            params.push(("albumId", id.to_string()));
        }
        for id in artist_ids {
            params.push(("artistId", id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("star", &param_refs).await?;
        Ok(())
    }

    /// Unstar songs, albums, or artists.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/unstar/>
    pub async fn unstar(
        &self,
        ids: &[&str],
        album_ids: &[&str],
        artist_ids: &[&str],
    ) -> Result<(), Error> {
        let mut params = Vec::new();
        for id in ids {
            params.push(("id", id.to_string()));
        }
        for id in album_ids {
            params.push(("albumId", id.to_string()));
        }
        for id in artist_ids {
            params.push(("artistId", id.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("unstar", &param_refs).await?;
        Ok(())
    }

    /// Set the rating of a song, album, or artist.
    ///
    /// A rating of 0 removes the rating.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/setrating/>
    pub async fn set_rating(&self, id: &str, rating: i32) -> Result<(), Error> {
        let rating_str = rating.to_string();
        self.get_response("setRating", &[("id", id), ("rating", &rating_str)])
            .await?;
        Ok(())
    }

    /// Register a song as played (scrobble).
    ///
    /// If `submission` is `false`, this is a "now playing" notification rather than a scrobble.
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/scrobble/>
    pub async fn scrobble(
        &self,
        id: &str,
        time: Option<i64>,
        submission: Option<bool>,
    ) -> Result<(), Error> {
        let mut params = vec![("id", id.to_string())];
        if let Some(t) = time {
            params.push(("time", t.to_string()));
        }
        if let Some(s) = submission {
            params.push(("submission", s.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("scrobble", &param_refs).await?;
        Ok(())
    }

    /// Report playback state to the server (OpenSubsonic, playbackReport extension).
    ///
    /// See <https://opensubsonic.netlify.app/docs/endpoints/reportplayback/>
    pub async fn report_playback(
        &self,
        media_id: &str,
        media_type: &str,
        position_ms: i64,
        state: &str,
        playback_rate: Option<f64>,
        ignore_scrobble: Option<bool>,
    ) -> Result<(), Error> {
        let position_str = position_ms.to_string();
        let mut params = vec![
            ("mediaId", media_id.to_string()),
            ("mediaType", media_type.to_string()),
            ("positionMs", position_str),
            ("state", state.to_string()),
        ];
        if let Some(r) = playback_rate {
            params.push(("playbackRate", r.to_string()));
        }
        if let Some(i) = ignore_scrobble {
            params.push(("ignoreScrobble", i.to_string()));
        }
        let param_refs: Vec<(&str, &str)> = params.iter().map(|(k, v)| (*k, v.as_str())).collect();
        self.get_response("reportPlayback", &param_refs).await?;
        Ok(())
    }
}