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

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

/// API functions related to the virtual camera.
pub struct VirtualCam<'a> {
    pub(super) client: &'a Client,
}

impl VirtualCam<'_> {
    /// Gets the status of the virtual cam output.
    #[doc(alias = "GetVirtualCamStatus")]
    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 virtual cam output.
    #[doc(alias = "ToggleVirtualCam")]
    pub async fn toggle(&self) -> Result<bool> {
        self.client
            .send_message::<_, responses::OutputActive>(Request::Toggle)
            .await
            .map(|oa| oa.active)
    }

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

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