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

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

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

impl Streaming<'_> {
    /// Gets the status of the stream output.
    #[doc(alias = "GetStreamStatus")]
    pub async fn status(&self) -> Result<responses::StreamStatus> {
        self.client.send_message(Request::GetStreamStatus).await
    }

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

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

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

    /// Sends CEA-608 caption text over the stream output.
    #[doc(alias = "SendStreamCaption")]
    pub async fn send_caption(&self, caption_text: &str) -> Result<()> {
        self.client
            .send_message(Request::SendStreamCaption { caption_text })
            .await
    }
}