apple-music 0.11.5

A Rust Library to fully control local MacOS Apple Music player.
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

//! # Apple Music
//! _A Rust Library to fully control local MacOS Apple Music player._
//
//! [![crates.io](https://img.shields.io/crates/v/apple-music.svg)](https://crates.io/crates/apple-music)
//! [![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)](https://crates.io/crates/apple-music)
//! [![docs.rs](https://img.shields.io/docsrs/apple-music)](https://docs.rs/apple-music/latest)
//
//! This crate provides a convenient way of controlling a MacOS Apple Music player, fully through Rust code.
//! The logic behind this crate relies on Apple's scripting APIs through [`osascript` CLI](https://ss64.com/mac/osascript.html) and `JavaScript` scripts.
//
//! ## Installation
//! `apple-music` is available directly on crates.io:
//! ```shell
//! cargo add apple-music
//! ```
//
//! ## How-to
//! Import the library in your project:
//! ```rust
//! use apple-music::AppleMusic;
//! ```
//
//! The library entry point is `AppleMusic`. From there, you can:
//! - Get the application's data - `AppleMusic::get_application_data();` -> `ApplicationData`
//! - Get the current track - `AppleMusic::get_current_track();` -> `Track`
//!   - Track can then be used directly:
//!     - Favorite / dislike Track - `track.set_favorited(true);` or `track.set_disliked(true);`
//!     - Download Track - `track.download()`
//!     - Reveal Track in Player - `track.reveal_in_player()`
//
//
//! - Get the current playlist - `AppleMusic::get_current_playlist();` -> `Playlist`
//!   - Playlist can then be used directly:
//!     - Search for a track in a playlist - `playlist.search_for_tracks(track_name)` -> `Vec<Track>`
//!     - Reveal Playlist in player - `playlist.reveal_in_player()`
//!     - Download Playlist - `playlist.download()`
//
//! To control the player, you can do it directly using `AppleMusic`:
//! - Set the volume - `AppleMusic::set_sound_volume(50);`
//! - Change track - `AppleMusic::next_track();`
//! - Play specific Track - `AppleMusic::play_track(Track);`
//! - Pause - `AppleMusic::pause();`
//! - Quit the application - `AppleMusic::quit();`
//
//
//! That is just a part of the available API, without even mentioning the data you have access to.
//
//! For more info and an exhaustive list of what's available, please check out the [documentation](https://docs.rs/apple-music/latest)!
//
//
//! ## Example
//! ```rust
//! let playlist = &AppleMusic::get_playlist_by_id(1234).unwrap();
//! AppleMusic::play_playlist(playlist); //! Apple Music player starts playing provided Playlist.
//
//! AppleMusic::set_shuffle(true); //! Shuffle is now enabled on currently playing Playlist.
//
//! let track = playlist.fetch_playlist_tracks().unwrap()[5];
//! AppleMusic::play_track(track); //! Apple Music player starts playing provided Track.
//
//! let current_track = AppleMusic::get_current_track().unwrap();
//! println!("{}", current_track.name()); //! "An awesome song!"
//
//! println!("{}", current_track.artwork_url()); //! Prints the direct url for the Artwork of the Track.
//
//! current_track.set_favorited(true); //! Track is now favorited!
//
//! AppleMusic::next_track(); //! Goes to next track.
//
//! let current_track = AppleMusic::get_current_track().unwrap();
//! current_track.reveal_in_player(); //! Track is revealed and selected on Apple Music player.
//
//! current_track.set_disliked(true); //! Track is now disliked!
//
//! AppleMusic::set_sound_volume(15); //! Sets Player volume to 15.
//
//! playlist.download(); //! Playlist is being downloaded on Apple Music player.
//
//! AppleMusic::quit(); //! Quit Apple Music application on Mac.
//! ```
//
//! ## Limitations
//! ### Platforms
//! This crate only works on MacOs, and has only been tested with macOS 13.4.1 and Apple Music 1.3.5.
//
//! I would be more than happy provide support for other version of MacOs / Apple Music, do not hesitate to open an issue if you are facing failures!
//
//! ## Next Steps
//! _Before v1.0:_
//! - Finish to add remaining classes & methods:
//!   - `ADD()`
//!   - `EXPORT()`
//!   - `REFRESH()`
//!   - Ensure the whole API is covered by this crate

mod script_controller;

mod error;
mod track;

mod apple_music;
mod application_data;
mod playlist;

pub use apple_music::*;
pub use application_data::*;
pub use playlist::*;
pub use track::*;
pub use error::*;