media-remote 0.3.7

Bindings for MediaRemote.framework
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

use crate::{send_command, Command};

macro_rules! send_command {
    ($self:expr,$command:expr) => {{
        if $self.is_info_some() {
            send_command($command)
        } else {
            false
        }
    }};
}

pub trait Controller {
    fn is_info_some(&self) -> bool;

    /// Toggles between play and pause states.
    ///
    /// # Returns
    /// - `true` if the command was successfully sent.
    /// - `false` if the command failed.
    ///
    /// # Example
    /// ```rust
    /// use media_remote::prelude::*;
    ///
    /// let now_playing = NowPlaying::new();
    /// now_playing.toggle();
    /// ```
    fn toggle(&self) -> bool {
        send_command!(self, Command::TogglePlayPause)
    }

    /// Play the currently playing media.
    ///
    /// # Returns
    /// - `true` if the command was successfully sent.
    /// - `false` if the operation failed.
    ///
    /// # Example
    /// ```rust
    /// use media_remote::prelude::*;
    ///
    /// let now_playing = NowPlaying::new();
    /// now_playing.play();
    /// ```
    fn play(&self) -> bool {
        send_command!(self, Command::Play)
    }

    /// Pauses the currently playing media.
    ///
    /// # Returns
    /// - `true` if the command was successfully sent.
    /// - `false` if the command failed.
    ///
    /// # Example
    /// ```rust
    /// use media_remote::prelude::*;
    ///
    /// let now_playing = NowPlaying::new();
    /// now_playing.pause();
    /// ```
    fn pause(&self) -> bool {
        send_command!(self, Command::Pause)
    }

    /// Skips to the next track in the playback queue.
    ///
    /// # Returns
    /// - `true` if the command was successfully sent.
    /// - `false` if the command failed.
    ///
    /// # Example
    /// ```rust
    /// use media_remote::prelude::*;
    ///
    /// let now_playing = NowPlaying::new();
    /// now_playing.next();
    /// ```
    fn next(&self) -> bool {
        send_command!(self, Command::NextTrack)
    }

    /// Returns to the previous track in the playback queue.
    ///
    /// # Returns
    /// - `true` if the command was successfully sent.
    /// - `false` if the command failed.
    ///
    /// # Example
    /// ```rust
    /// use media_remote::prelude::*;
    ///
    /// let now_playing = NowPlaying::new();
    /// now_playing.previous();
    /// ```
    fn previous(&self) -> bool {
        send_command!(self, Command::PreviousTrack)
    }
}