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

use super::Client;
use crate::{
    error::Result,
    requests::hotkeys::{KeyModifiers, Request},
    responses::hotkeys as responses,
};

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

impl Hotkeys<'_> {
    /// Gets an array of all hotkey names in OBS.
    #[doc(alias = "GetHotkeyList")]
    pub async fn list(&self) -> Result<Vec<String>> {
        self.client
            .send_message::<_, responses::Hotkeys>(Request::List)
            .await
            .map(|h| h.hotkeys)
    }

    /// Triggers a hotkey using its name. See [`Self::list`].
    #[doc(alias = "TriggerHotkeyByName")]
    pub async fn trigger_by_name(&self, name: &str, context: Option<&str>) -> Result<()> {
        self.client
            .send_message(Request::TriggerByName { name, context })
            .await
    }

    /// Triggers a hotkey using a sequence of keys.
    #[doc(alias = "TriggerHotkeyByKeySequence")]
    pub async fn trigger_by_sequence(&self, id: &str, modifiers: KeyModifiers) -> Result<()> {
        self.client
            .send_message(Request::TriggerBySequence { id, modifiers })
            .await
    }
}