stream_deck_sdk 1.0.6

Rust unofficial SDK for the Elgato Stream Deck
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

use async_trait::async_trait;

use crate::events::events::{
    AppearEvent, ApplicationEvent, DeviceDidConnectEvent, DeviceDidDisconnectEvent, DialPressEvent,
    DialRotateEvent, DidReceiveGlobalSettingsEvent, DidReceiveSettingsEvent, KeyEvent,
    PropertyInspectorAppearEvent, SendToPluginEvent, SystemDidWakeUpEvent,
    TitleParametersDidChangeEvent, TouchTapEvent,
};
use crate::stream_deck::StreamDeck;

#[async_trait]
#[allow(unused)]
pub trait Action: Sync {
    fn uuid(&self) -> &str;
    fn long_timeout(&self) -> f32 {
        0.0
    }
    async fn on_appear(&self, e: AppearEvent, sd: StreamDeck) {}
    async fn on_disappear(&self, e: AppearEvent, sd: StreamDeck) {}
    async fn on_key_down(&self, e: KeyEvent, sd: StreamDeck) {}
    async fn on_key_up(&self, e: KeyEvent, sd: StreamDeck) {}
    // custom actions
    async fn on_long_press(&self, e: KeyEvent, timeout: f32, sd: StreamDeck) {}
    // settings
    async fn on_settings_changed(&self, e: DidReceiveSettingsEvent, sd: StreamDeck) {}
    async fn on_global_settings_changed(&self, e: DidReceiveGlobalSettingsEvent, sd: StreamDeck) {}
    // dial
    async fn on_dial_rotate(&self, e: DialRotateEvent, sd: StreamDeck) {}
    async fn on_dial_press(&self, e: DialPressEvent, sd: StreamDeck) {}
    // touch
    async fn on_touch_tap(&self, e: TouchTapEvent, sd: StreamDeck) {}
    // other events
    async fn on_title_parameters_changed(&self, e: TitleParametersDidChangeEvent, sd: StreamDeck) {}
    async fn on_device_connect(&self, e: DeviceDidConnectEvent, sd: StreamDeck) {}
    async fn on_device_disconnect(&self, e: DeviceDidDisconnectEvent, sd: StreamDeck) {}
    async fn on_application_launch(&self, e: ApplicationEvent, sd: StreamDeck) {}
    async fn on_application_terminate(&self, e: ApplicationEvent, sd: StreamDeck) {}
    async fn on_system_wake_up(&self, e: SystemDidWakeUpEvent, sd: StreamDeck) {}
    async fn on_property_inspector_appear(&self, e: PropertyInspectorAppearEvent, sd: StreamDeck) {}
    async fn on_property_inspector_disappear(
        &self,
        e: PropertyInspectorAppearEvent,
        sd: StreamDeck,
    ) {
    }
    async fn on_send_to_plugin(&self, e: SendToPluginEvent, sd: StreamDeck) {}
}