soundpad-remote-client 0.1.0

A client for the Soundpad remote control interface
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

use core::time::Duration;
use derivative::Derivative;
use std::fmt::Debug;
use tokio::sync::mpsc;
use tracing::{info, instrument};

use crate::{error::Error, response_code::SuccessCode, Sound, SoundList};

mod builder;
mod command;
mod connection;

pub use builder::ClientBuilder;
pub(crate) use command::Command;
pub(crate) use connection::Connection;

type Result<T> = std::result::Result<T, Error>;

/// A client for communicating with Soundpad
///
/// You can create a client using the [`ClientBuilder`].
///
/// # Examples
///
/// ```ignore
/// let client = ClientBuilder::new().connect()?;
/// let sounds = client.get_sound_list()?;
/// client.play_sound(&sounds[0])?;
/// ```
#[derive(Derivative)]
#[derivative(Debug, Clone)]
pub struct Client {
    #[derivative(Debug = "ignore")]
    pub(crate) tx: mpsc::Sender<Command>,
    pub debounce: Duration,
}

impl Client {
    #[instrument]
    pub async fn custom_command(
        &self,
        command: impl ToString + Debug,
        cooldown: Duration,
    ) -> Result<SuccessCode> {
        Command::new(command.to_string())
            .with_cooldown(cooldown)
            .issue::<SuccessCode, _>(self)
            .await
    }

    #[instrument]
    pub async fn get_sound_list(&self) -> Result<Vec<Sound>> {
        Command::new("GetSoundList()")
            .issue::<SoundList, _>(self)
            .await
            .map(|sl| sl.sounds)
    }

    #[instrument]
    pub async fn play_sound(&self, sound: &Sound) -> Result<()> {
        let msg = format!("DoPlaySound({})", sound.index);

        let _ = Command::new(msg.clone())
            .with_cooldown(self.debounce)
            .issue::<SuccessCode, _>(self)
            .await?;

        info!("{}", sound.title);

        Ok(())
    }
}