am-api 1.1.0

A library for interfacing with the Apple Music 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

//! Apple music primitive types

use serde::{Deserialize, Serialize};
use std::fmt::Display;

/// Play parameters
#[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Hash)]
#[serde(rename_all = "camelCase", default)]
pub struct PlayParameters {
    /// Song id
    pub id: String,
    /// Parameters kind
    pub kind: String,
}

/// Editorial notes
#[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Hash)]
#[serde(rename_all = "camelCase", default)]
pub struct EditorialNotes {
    /// Name for the editorial notes
    pub name: Option<String>,
    /// Abbreviated notes that display inline or when the content appears alongside other content
    pub short: Option<String>,
    /// Notes that appear when the content displays prominently
    pub standard: Option<String>,
    /// Tag line for the editorial notes
    pub tagline: Option<String>,
}

/// Preview
#[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, Hash)]
#[serde(rename_all = "camelCase", default)]
pub struct Preview {
    /// Preview url
    pub url: String,
}

/// Audio variants
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
pub enum AudioVariant {
    /// Dolby atmos
    #[serde(rename = "dolby-atmos")]
    DolbyAtmos,
    /// Dolby audio
    #[serde(rename = "dolby-audio")]
    DolbyAudio,
    /// Hi-Res lossless
    #[serde(rename = "hi-res-lossless")]
    HiResLossless,
    /// Lossless
    #[serde(rename = "lossless")]
    Lossless,
    /// Lossy stereo
    #[serde(rename = "lossy-stereo")]
    LossyStereo,
}

/// Content rating
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
pub enum ContentRating {
    /// Clean
    #[serde(rename = "clean")]
    Clean,
    /// Explicit
    #[serde(rename = "explicit")]
    Explicit,
}

/// Track types
#[derive(Serialize, Deserialize, Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum TrackType {
    /// Library music video
    ///
    /// Resource: [`LibraryMusicVideo`]
    #[serde(rename = "library-music-videos")]
    LibraryMusicVideo,
    /// Library song
    ///
    /// Resource: [`LibrarySong`]
    #[serde(rename = "library-songs")]
    LibrarySong,
    /// Music video
    ///
    /// Resource: [`MusicVideo`]
    #[serde(rename = "music-videos")]
    MusicVideo,
    /// Song
    ///
    /// Resource: [`Song`]
    #[serde(rename = "songs")]
    Song,
}

impl Display for TrackType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let string = match self {
            TrackType::LibraryMusicVideo => "library-music-videos",
            TrackType::LibrarySong => "library-songs",
            TrackType::MusicVideo => "music-videos",
            TrackType::Song => "songs",
        };
        write!(f, "{}", string)
    }
}