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

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

/// API functions related to the replay buffer.
pub struct ReplayBuffer<'a> {
    pub(super) client: &'a Client,
}

impl ReplayBuffer<'_> {
    /// Gets the status of the replay buffer output.
    #[doc(alias = "GetReplayBufferStatus")]
    pub async fn status(&self) -> Result<bool> {
        self.client
            .send_message::<_, responses::OutputActive>(Request::Status)
            .await
            .map(|oa| oa.active)
    }

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

    /// Starts the replay buffer output.
    #[doc(alias = "StartReplayBuffer")]
    pub async fn start(&self) -> Result<()> {
        self.client.send_message(Request::Start).await
    }

    /// Stops the replay buffer output.
    #[doc(alias = "StopReplayBuffer")]
    pub async fn stop(&self) -> Result<()> {
        self.client.send_message(Request::Stop).await
    }

    /// Saves the contents of the replay buffer output.
    #[doc(alias = "SaveReplayBuffer")]
    pub async fn save(&self) -> Result<()> {
        self.client.send_message(Request::Save).await
    }

    /// Gets the file name of the last replay buffer save file.
    #[doc(alias = "GetLastReplayBufferReplay")]
    pub async fn last_replay(&self) -> Result<String> {
        self.client
            .send_message::<_, responses::SavedReplayPath>(Request::LastReplay)
            .await
            .map(|srp| srp.saved_replay_path)
    }
}