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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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)
}
/// Toggles the shuffle state of 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.toggle_shuffle();
/// ```
fn toggle_shuffle(&self) -> bool {
send_command!(self, Command::ToggleShuffle)
}
/// Toggles the repeat state of 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.toggle_repeat();
/// ```
fn toggle_repeat(&self) -> bool {
send_command!(self, Command::ToggleRepeat)
}
/// Starts a forward seek operation.
///
/// # 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.start_forward_seek();
/// ```
fn start_forward_seek(&self) -> bool {
send_command!(self, Command::StartForwardSeek)
}
/// Ends a forward seek operation.
///
/// # 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.end_forward_seek();
/// ```
fn end_forward_seek(&self) -> bool {
send_command!(self, Command::EndForwardSeek)
}
/// Starts a backward seek operation.
///
/// # 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.start_backward_seek();
/// ```
fn start_backward_seek(&self) -> bool {
send_command!(self, Command::StartBackwardSeek)
}
/// Ends a backward seek operation.
///
/// # 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.end_backward_seek();
/// ```
fn end_backward_seek(&self) -> bool {
send_command!(self, Command::EndBackwardSeek)
}
/// Seeks backward by fifteen seconds.
///
/// # 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.go_back_fifteen_seconds();
/// ```
fn go_back_fifteen_seconds(&self) -> bool {
send_command!(self, Command::GoBackFifteenSeconds)
}
/// Skips forward by fifteen seconds.
///
/// # 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.skip_fifteen_seconds();
/// ```
fn skip_fifteen_seconds(&self) -> bool {
send_command!(self, Command::SkipFifteenSeconds)
}
/// Sets the playback speed of the currently active media client.
///
/// # Arguments
/// - `speed`: The playback speed multiplier.
///
/// # Note
/// - Playback speed changes typically do not work most of the time.
/// Depending on the media client or content, setting the playback speed may not have the desired effect.
///
/// # Example
/// ```rust
/// use media_remote::prelude::*;
///
/// let now_playing = NowPlaying::new();
/// now_playing.set_playback_speed(2);
/// ```
fn set_playback_speed(&self, speed: i32) {
if self.is_info_some() {
crate::set_playback_speed(speed);
}
}
/// Sets the elapsed time of the currently playing media.
///
/// # Arguments
/// - `elapsed_time`: The elapsed time in seconds to set the current position of the media.
///
/// # Note
/// - **Limitations**: Setting the elapsed time can often cause the media to pause. Be cautious
/// when using this function, as the playback might be interrupted and require manual resumption.
///
/// # Example
/// ```rust
/// use media_remote::prelude::*;
///
/// let now_playing = NowPlaying::new();
/// now_playing.set_elapsed_time(1.0);
/// ```
fn set_elapsed_time(&self, elapsed_time: f64) {
if self.is_info_some() {
crate::set_elapsed_time(elapsed_time);
}
}
}