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

//! Responses related to transitions.

use serde::{Deserialize, Serialize};
use time::Duration;

pub use super::ids::{CurrentSceneTransitionId, TransitionId};

/// Response value for [`crate::client::Transitions::list_kinds`].
#[derive(Debug, Deserialize)]
pub(crate) struct TransitionKinds {
    /// Array of transition kinds.
    #[serde(rename = "transitionKinds")]
    pub transition_kinds: Vec<String>,
}

/// Response value for [`crate::client::Transitions::list`].
#[derive(Clone, Debug, Default, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub struct SceneTransitionList {
    /// Identifier of the current scene transition.
    #[serde(flatten)]
    pub current_scene_transition: Option<CurrentSceneTransitionId>,
    /// Kind of the current scene transition.
    #[serde(rename = "currentSceneTransitionKind")]
    pub current_scene_transition_kind: Option<String>,
    /// Array of transitions.
    #[serde(rename = "transitions")]
    pub transitions: Vec<Transition>,
}

/// Response value for [`crate::client::Transitions::list`] as part of [`SceneTransitionList`].
#[derive(Clone, Debug, Default, Deserialize, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
pub struct Transition {
    /// Identifier of the transition.
    #[serde(flatten)]
    pub id: TransitionId,
    /// Kind of the transition.
    #[serde(rename = "transitionKind")]
    pub kind: String,
    /// Whether the transition uses a fixed (non-configurable) duration.
    #[serde(rename = "transitionFixed")]
    pub fixed: bool,
    /// Whether the transition supports being configured.
    #[serde(rename = "transitionConfigurable")]
    pub configurable: bool,
}

/// Response value for [`crate::client::Transitions::current`].
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct CurrentSceneTransition {
    /// Identifier of the transition.
    #[serde(flatten)]
    pub id: TransitionId,
    /// Kind of the transition.
    #[serde(rename = "transitionKind")]
    pub kind: String,
    /// Whether the transition uses a fixed (non-configurable) duration.
    #[serde(rename = "transitionFixed")]
    pub fixed: bool,
    /// Configured transition duration in milliseconds.
    #[serde(
        rename = "transitionDuration",
        with = "crate::serde::duration_millis::option"
    )]
    pub duration: Option<Duration>,
    /// Whether the transition supports being configured.
    #[serde(rename = "transitionConfigurable")]
    pub configurable: bool,
    /// Object of settings for the transition.
    #[serde(rename = "transitionSettings")]
    pub settings: Option<serde_json::Value>,
}

/// Response value for [`crate::client::Transitions::current_cursor`].
#[derive(Debug, Deserialize)]
pub(crate) struct TransitionCursor {
    /// Cursor position, between `0.0` and `1.0`.
    #[serde(rename = "transitionCursor")]
    pub transition_cursor: f32,
}