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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use serde::Serialize;
use time::Duration;

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

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

impl Transitions<'_> {
    /// Gets an array of all available transition kinds.
    #[doc(alias = "GetTransitionKindList")]
    pub async fn list_kinds(&self) -> Result<Vec<String>> {
        self.client
            .send_message::<_, responses::TransitionKinds>(Request::GetTransitionKindList)
            .await
            .map(|tk| tk.transition_kinds)
    }

    /// Gets an array of all scene transitions in OBS.
    #[doc(alias = "GetSceneTransitionList")]
    pub async fn list(&self) -> Result<responses::SceneTransitionList> {
        self.client
            .send_message(Request::GetSceneTransitionList)
            .await
    }

    /// Gets information about the current scene transition.
    #[doc(alias = "GetCurrentSceneTransition")]
    pub async fn current(&self) -> Result<responses::CurrentSceneTransition> {
        self.client
            .send_message(Request::GetCurrentSceneTransition)
            .await
    }

    /// Sets the current scene transition.
    ///
    /// **Small note:** While the namespace of scene transitions is generally unique, that
    /// uniqueness is not a guarantee as it is with other resources like inputs.
    #[doc(alias = "SetCurrentSceneTransition")]
    pub async fn set_current(&self, name: &str) -> Result<()> {
        self.client
            .send_message(Request::SetCurrentSceneTransition { name })
            .await
    }

    /// Sets the duration of the current scene transition, if it is not fixed.
    #[doc(alias = "SetCurrentSceneTransitionDuration")]
    pub async fn set_current_duration(&self, duration: Duration) -> Result<()> {
        self.client
            .send_message(Request::SetCurrentSceneTransitionDuration { duration })
            .await
    }

    /// Sets the settings of the current scene transition.
    #[doc(alias = "SetCurrentSceneTransitionSettings")]
    pub async fn set_current_settings<T>(&self, settings: T, overlay: Option<bool>) -> Result<()>
    where
        T: Serialize,
    {
        self.client
            .send_message(Request::SetCurrentSceneTransitionSettings {
                settings: serde_json::to_value(&settings)
                    .map_err(crate::error::SerializeCustomDataError)?,
                overlay,
            })
            .await
    }

    /// Gets the cursor position of the current scene transition.
    ///
    /// **Note:** `transitionCursor` will return `1.0` when the transition is inactive.
    #[doc(alias = "GetCurrentSceneTransitionCursor")]
    pub async fn current_cursor(&self) -> Result<f32> {
        self.client
            .send_message::<_, responses::TransitionCursor>(
                Request::GetCurrentSceneTransitionCursor,
            )
            .await
            .map(|tc| tc.transition_cursor)
    }

    /// Triggers the current scene transition. Same functionality as the `Transition` button in
    /// studio mode.
    #[doc(alias = "TriggerStudioModeTransition")]
    pub async fn trigger(&self) -> Result<()> {
        self.client
            .send_message(Request::TriggerStudioModeTransition)
            .await
    }

    /// Sets the position of the T-Bar.
    ///
    /// **Very important note:** This will be deprecated and replaced in a future version of
    /// `obs-websocket`.
    #[doc(alias = "SetTBarPosition")]
    pub async fn set_tbar_position(&self, position: f32, release: Option<bool>) -> Result<()> {
        self.client
            .send_message(Request::SetTbarPosition { position, release })
            .await
    }
}