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
115
116

//! Requests related to the OBS configuration.

use serde::Serialize;
use serde_with::skip_serializing_none;

#[derive(Serialize)]
#[serde(tag = "requestType", content = "requestData")]
pub(crate) enum Request<'a> {
    #[serde(rename = "GetPersistentData")]
    GetPersistentData {
        /// The data realm to select.
        #[serde(rename = "realm")]
        realm: Realm,
        /// The name of the slot to retrieve data from.
        #[serde(rename = "slotName")]
        slot_name: &'a str,
    },
    #[serde(rename = "SetPersistentData")]
    SetPersistentData(SetPersistentData<'a>),
    #[serde(rename = "GetVideoSettings")]
    VideoSettings,
    #[serde(rename = "SetVideoSettings")]
    SetVideoSettings(SetVideoSettings),
    #[serde(rename = "GetStreamServiceSettings")]
    StreamServiceSettings,
    #[serde(rename = "SetStreamServiceSettings")]
    SetStreamServiceSettings {
        /// Type of stream service to apply. Example: `rtmp_common` or `rtmp_custom`.
        #[serde(rename = "streamServiceType")]
        r#type: &'a str,
        /// Settings to apply to the service.
        #[serde(rename = "streamServiceSettings")]
        settings: serde_json::Value,
    },
    #[serde(rename = "GetRecordDirectory")]
    RecordDirectory,
    #[serde(rename = "SetRecordDirectory")]
    SetRecordDirectory {
        /// Output directory.
        #[serde(rename = "recordDirectory")]
        directory: &'a str,
    },
}

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

/// Request information for [`crate::client::Config::get_persistent_data`] and
/// [`crate::client::Config::set_persistent_data`] as part of
/// [`SetPersistentData`].
#[derive(Clone, Copy, Serialize)]
#[non_exhaustive]
pub enum Realm {
    /// Data located in the global settings.
    #[serde(rename = "OBS_WEBSOCKET_DATA_REALM_GLOBAL")]
    Global,
    /// Data bound to the current profile.
    #[serde(rename = "OBS_WEBSOCKET_DATA_REALM_PROFILE")]
    Profile,
}

/// Request information for [`crate::client::Config::set_persistent_data`].
#[derive(Serialize)]
#[cfg_attr(feature = "builder", derive(bon::Builder))]
pub struct SetPersistentData<'a> {
    /// The data realm to select.
    #[serde(rename = "realm")]
    pub realm: Realm,
    /// The name of the slot to retrieve data from.
    #[serde(rename = "slotName")]
    pub slot_name: &'a str,
    /// The value to apply to the slot.
    #[serde(rename = "slotValue")]
    pub slot_value: &'a serde_json::Value,
}

/// Request information for [`crate::client::Config::set_video_settings`].
#[skip_serializing_none]
#[derive(Default, Serialize)]
#[cfg_attr(feature = "builder", derive(bon::Builder))]
pub struct SetVideoSettings {
    /// Numerator of the fractional FPS value.
    #[serde(rename = "fpsNumerator")]
    pub fps_numerator: Option<u32>,
    /// Denominator of the fractional FPS value.
    #[serde(rename = "fpsDenominator")]
    pub fps_denominator: Option<u32>,
    /// Width of the base (canvas) resolution in pixels.
    #[serde(rename = "baseWidth")]
    pub base_width: Option<u32>,
    /// Height of the base (canvas) resolution in pixels.
    #[serde(rename = "baseHeight")]
    pub base_height: Option<u32>,
    /// Width of the output resolution in pixels.
    #[serde(rename = "outputWidth")]
    pub output_width: Option<u32>,
    /// Height of the output resolution in pixels.
    #[serde(rename = "outputHeight")]
    pub output_height: Option<u32>,
}

impl From<crate::responses::config::VideoSettings> for SetVideoSettings {
    fn from(v: crate::responses::config::VideoSettings) -> Self {
        Self {
            fps_numerator: Some(v.fps_numerator),
            fps_denominator: Some(v.fps_denominator),
            base_width: Some(v.base_width),
            base_height: Some(v.base_height),
            output_width: Some(v.output_width),
            output_height: Some(v.output_height),
        }
    }
}