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

use time::Duration;

use super::Client;
use crate::{
    common::MediaAction,
    error::Result,
    requests::{inputs::InputId, media_inputs::Request},
    responses::media_inputs as responses,
};

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

impl MediaInputs<'_> {
    /// Gets the status of a media input.
    #[doc(alias = "GetMediaInputStatus")]
    pub async fn status(&self, input: InputId<'_>) -> Result<responses::MediaStatus> {
        self.client.send_message(Request::Status { input }).await
    }

    /// Sets the cursor position of a media input.
    ///
    /// This request does not perform bounds checking of the cursor position.
    #[doc(alias = "SetMediaInputCursor")]
    pub async fn set_cursor(&self, input: InputId<'_>, cursor: Duration) -> Result<()> {
        self.client
            .send_message(Request::SetCursor { input, cursor })
            .await
    }

    /// Offsets the current cursor position of a media input by the specified value.
    ///
    /// This request does not perform bounds checking of the cursor position.
    #[doc(alias = "OffsetMediaInputCursor")]
    pub async fn offset_cursor(&self, input: InputId<'_>, offset: Duration) -> Result<()> {
        self.client
            .send_message(Request::OffsetCursor { input, offset })
            .await
    }

    /// Triggers an action on a media input.
    #[doc(alias = "TriggerMediaInputAction")]
    pub async fn trigger_action(&self, input: InputId<'_>, action: MediaAction) -> Result<()> {
        self.client
            .send_message(Request::TriggerAction { input, action })
            .await
    }
}