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

//! Requests related to scenes.

use serde::Serialize;
use serde_with::skip_serializing_none;
use time::Duration;

pub use super::ids::SceneId;

#[skip_serializing_none]
#[derive(Serialize)]
#[serde(tag = "requestType", content = "requestData")]
pub(crate) enum Request<'a> {
    #[serde(rename = "GetSceneList")]
    List,
    #[serde(rename = "GetGroupList")]
    ListGroups,
    #[serde(rename = "GetCurrentProgramScene")]
    CurrentProgramScene,
    #[serde(rename = "SetCurrentProgramScene")]
    SetCurrentProgramScene {
        /// Scene to set as the current program scene.
        #[serde(flatten)]
        scene: SceneId<'a>,
    },
    #[serde(rename = "GetCurrentPreviewScene")]
    CurrentPreviewScene,
    #[serde(rename = "SetCurrentPreviewScene")]
    SetCurrentPreviewScene {
        /// Scene to set as the current preview scene.
        #[serde(flatten)]
        scene: SceneId<'a>,
    },
    #[serde(rename = "SetSceneName")]
    SetName {
        /// The scene to be renamed.
        #[serde(flatten)]
        scene: SceneId<'a>,
        /// New name for the scene.
        #[serde(rename = "newSceneName")]
        new_name: &'a str,
    },
    #[serde(rename = "CreateScene")]
    Create {
        /// Name for the new scene.
        #[serde(rename = "sceneName")]
        name: &'a str,
    },
    #[serde(rename = "RemoveScene")]
    Remove {
        /// The scene to remove.
        #[serde(flatten)]
        scene: SceneId<'a>,
    },
    #[serde(rename = "GetSceneSceneTransitionOverride")]
    TransitionOverride {
        /// Identifier of the scene.
        #[serde(flatten)]
        scene: SceneId<'a>,
    },
    #[serde(rename = "SetSceneSceneTransitionOverride")]
    SetTransitionOverride(SetTransitionOverride<'a>),
}

impl<'a> From<Request<'a>> for super::RequestType<'a> {
    fn from(value: Request<'a>) -> Self {
        super::RequestType::Scenes(value)
    }
}

/// Request information for [`crate::client::Scenes::set_transition_override`].
#[skip_serializing_none]
#[derive(Default, Serialize)]
pub struct SetTransitionOverride<'a> {
    /// The target scene.
    #[serde(flatten)]
    pub scene: SceneId<'a>,
    /// Name of the scene transition to use as override.
    #[serde(rename = "transitionName")]
    pub transition: Option<&'a str>,
    /// Duration to use for any overridden transition.
    #[serde(
        rename = "transitionDuration",
        with = "crate::serde::duration_millis::option"
    )]
    pub duration: Option<Duration>,
}