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
105
106
107
108
109
110
111
112
113
114

use uuid::Uuid;

use super::Client;
use crate::{
    error::Result,
    requests::scenes::{Request, SceneId, SetTransitionOverride},
    responses::scenes as responses,
};

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

impl Scenes<'_> {
    /// Gets an array of all scenes in OBS.
    #[doc(alias = "GetSceneList")]
    pub async fn list(&self) -> Result<responses::Scenes> {
        self.client.send_message(Request::List).await
    }

    /// Gets an array of all groups in OBS.
    ///
    /// Groups in OBS are actually scenes, but renamed and modified. In obs-websocket, we treat them
    /// as scenes where we can.
    #[doc(alias = "GetGroupList")]
    pub async fn list_groups(&self) -> Result<Vec<String>> {
        self.client
            .send_message::<_, responses::Groups>(Request::ListGroups)
            .await
            .map(|g| g.groups)
    }

    /// Gets the current program scene.
    #[doc(alias = "GetCurrentProgramScene")]
    pub async fn current_program_scene(&self) -> Result<responses::CurrentProgramScene> {
        self.client.send_message(Request::CurrentProgramScene).await
    }

    /// Sets the current program scene.
    #[doc(alias = "SetCurrentProgramScene")]
    pub async fn set_current_program_scene(&self, scene: impl Into<SceneId<'_>>) -> Result<()> {
        self.client
            .send_message(Request::SetCurrentProgramScene {
                scene: scene.into(),
            })
            .await
    }

    /// Gets the current preview scene.
    ///
    /// Only available when studio mode is enabled.
    #[doc(alias = "GetCurrentPreviewScene")]
    pub async fn current_preview_scene(&self) -> Result<responses::CurrentPreviewScene> {
        self.client.send_message(Request::CurrentPreviewScene).await
    }

    /// Sets the current preview scene.
    ///
    /// Only available when studio mode is enabled.
    #[doc(alias = "SetCurrentPreviewScene")]
    pub async fn set_current_preview_scene(&self, scene: impl Into<SceneId<'_>>) -> Result<()> {
        self.client
            .send_message(Request::SetCurrentPreviewScene {
                scene: scene.into(),
            })
            .await
    }

    /// Sets the name of a scene (rename).
    #[doc(alias = "SetSceneName")]
    pub async fn set_name(&self, scene: SceneId<'_>, new_name: &str) -> Result<()> {
        self.client
            .send_message(Request::SetName { scene, new_name })
            .await
    }

    /// Creates a new scene in OBS.
    #[doc(alias = "CreateScene")]
    pub async fn create(&self, name: &str) -> Result<Uuid> {
        self.client
            .send_message::<_, responses::CreateScene>(Request::Create { name })
            .await
            .map(|cs| cs.uuid)
    }

    /// Removes a scene from OBS.
    #[doc(alias = "RemoveScene")]
    pub async fn remove(&self, scene: SceneId<'_>) -> Result<()> {
        self.client.send_message(Request::Remove { scene }).await
    }

    /// Gets the scene transition overridden for a scene.
    #[doc(alias = "GetSceneSceneTransitionOverride")]
    pub async fn transition_override(
        &self,
        scene: SceneId<'_>,
    ) -> Result<responses::SceneTransitionOverride> {
        self.client
            .send_message(Request::TransitionOverride { scene })
            .await
    }

    /// Sets the scene transition overridden for a scene.
    #[doc(alias = "SetSceneSceneTransitionOverride")]
    pub async fn set_transition_override(
        &self,
        transition_override: SetTransitionOverride<'_>,
    ) -> Result<()> {
        self.client
            .send_message(Request::SetTransitionOverride(transition_override))
            .await
    }
}