Adjust hotkey command names

v5-api
Dominik Nakamura 2 years ago
parent db12a54e72
commit 59ea5e17cb
No known key found for this signature in database
GPG Key ID: E4C6A749B2491910

@ -11,28 +11,24 @@ pub struct Hotkeys<'a> {
impl<'a> Hotkeys<'a> {
/// Gets an array of all hotkey names in OBS.
pub async fn list_hotkeys(&self) -> Result<Vec<String>> {
pub async fn list(&self) -> Result<Vec<String>> {
self.client
.send_message::<_, responses::Hotkeys>(Request::ListHotkeys)
.send_message::<_, responses::Hotkeys>(Request::List)
.await
.map(|h| h.hotkeys)
}
/// Triggers a hotkey using its name. See [`General::list_hotkeys`].
pub async fn trigger_hotkey_by_name(&self, name: &str) -> Result<()> {
pub async fn trigger_by_name(&self, name: &str) -> Result<()> {
self.client
.send_message(Request::TriggerHotkeyByName { name })
.send_message(Request::TriggerByName { name })
.await
}
/// Triggers a hotkey using a sequence of keys.
pub async fn trigger_hotkey_by_key_sequence(
&self,
id: &str,
modifiers: KeyModifiers,
) -> Result<()> {
pub async fn trigger_by_sequence(&self, id: &str, modifiers: KeyModifiers) -> Result<()> {
self.client
.send_message(Request::TriggerHotkeyByKeySequence { id, modifiers })
.send_message(Request::TriggerBySequence { id, modifiers })
.await
}
}

@ -6,15 +6,15 @@ use serde::Serialize;
#[serde(tag = "requestType", content = "requestData")]
pub(crate) enum Request<'a> {
#[serde(rename = "GetHotkeyList")]
ListHotkeys,
List,
#[serde(rename = "TriggerHotkeyByName")]
TriggerHotkeyByName {
TriggerByName {
/// Name of the hotkey to trigger.
#[serde(rename = "hotkeyName")]
name: &'a str,
},
#[serde(rename = "TriggerHotkeyByKeySequence")]
TriggerHotkeyByKeySequence {
TriggerBySequence {
/// The OBS key ID to use.
#[serde(rename = "keyId")]
id: &'a str,

@ -8,10 +8,10 @@ async fn hotkeys() -> Result<()> {
let client = common::new_client().await?;
let client = client.hotkeys();
client.list_hotkeys().await?;
client.trigger_hotkey_by_name("ReplayBuffer.Save").await?;
client.list().await?;
client.trigger_by_name("ReplayBuffer.Save").await?;
client
.trigger_hotkey_by_key_sequence("OBS_KEY_P", KeyModifiers::default())
.trigger_by_sequence("OBS_KEY_P", KeyModifiers::default())
.await?;
Ok(())

Loading…
Cancel
Save