obws 0.15.0

The obws (obvious) remote control library for OBS.
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

use serde::{Serialize, de::DeserializeOwned};

use super::Client;
use crate::{error::Result, requests::outputs::Request, responses::outputs as responses};

/// API functions related to outputs.
pub struct Outputs<'a> {
    pub(super) client: &'a Client,
}

impl Outputs<'_> {
    /// Gets the list of available outputs.
    #[doc(alias = "GetOutputList")]
    pub async fn list(&self) -> Result<Vec<responses::Output>> {
        self.client
            .send_message::<_, responses::OutputList>(Request::List)
            .await
            .map(|ol| ol.outputs)
    }

    /// Gets the status of an output.
    #[doc(alias = "GetOutputStatus")]
    pub async fn status(&self, name: &str) -> Result<responses::OutputStatus> {
        self.client.send_message(Request::Status { name }).await
    }

    /// Toggles the status of an output.
    #[doc(alias = "ToggleOutput")]
    pub async fn toggle(&self, name: &str) -> Result<bool> {
        self.client
            .send_message::<_, responses::OutputActive>(Request::Toggle { name })
            .await
            .map(|oa| oa.active)
    }

    /// Starts an output.
    #[doc(alias = "StartOutput")]
    pub async fn start(&self, name: &str) -> Result<()> {
        self.client.send_message(Request::Start { name }).await
    }

    /// Stops an output.
    #[doc(alias = "StopOutput")]
    pub async fn stop(&self, name: &str) -> Result<()> {
        self.client.send_message(Request::Stop { name }).await
    }

    /// Gets the settings of an output.
    #[doc(alias = "GetOutputSettings")]
    pub async fn settings<T>(&self, name: &str) -> Result<T>
    where
        T: DeserializeOwned,
    {
        self.client
            .send_message::<_, responses::OutputSettings<T>>(Request::Settings { name })
            .await
            .map(|os| os.settings)
    }

    /// Sets the settings of an output.
    #[doc(alias = "SetOutputSettings")]
    pub async fn set_settings<T>(&self, name: &str, settings: T) -> Result<()>
    where
        T: Serialize,
    {
        self.client
            .send_message(Request::SetSettings {
                name,
                settings: serde_json::to_value(&settings)
                    .map_err(crate::error::SerializeCustomDataError)?,
            })
            .await
    }
}