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

//! General requests, not fitting into any category.

use serde::Serialize;

#[allow(clippy::enum_variant_names)]
#[derive(Serialize)]
#[serde(tag = "requestType", content = "requestData")]
pub(crate) enum Request<'a> {
    #[serde(rename = "GetVersion")]
    Version,
    #[serde(rename = "GetStats")]
    Stats,
    #[serde(rename = "BroadcastCustomEvent")]
    BroadcastCustomEvent {
        /// Data payload to emit to all receivers.
        #[serde(rename = "eventData")]
        event_data: serde_json::Value,
    },
    #[serde(rename = "CallVendorRequest")]
    CallVendorRequest(CallVendorRequestInternal<'a>),
    // TODO: Sleep
}

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

/// Request information for [`crate::client::General::call_vendor_request`].
#[cfg_attr(feature = "builder", derive(bon::Builder))]
pub struct CallVendorRequest<'a, T> {
    /// Name of the vendor to use.
    pub vendor_name: &'a str,
    /// The request type to call.
    pub request_type: &'a str,
    /// Object containing appropriate request data.
    pub request_data: &'a T,
}

/// Request information for [`crate::client::General::call_vendor_request`].
#[derive(Default, Serialize)]
pub(crate) struct CallVendorRequestInternal<'a> {
    /// Name of the vendor to use.
    #[serde(rename = "vendorName")]
    pub vendor_name: &'a str,
    /// The request type to call.
    #[serde(rename = "requestType")]
    pub request_type: &'a str,
    /// Object containing appropriate request data.
    #[serde(rename = "requestData")]
    pub request_data: serde_json::Value,
}