Struct AsyncStreamDeck

pub struct AsyncStreamDeck { /* private fields */ }

Available on crate feature async only.

Stream Deck interface suitable to be used in async, uses block_in_place so this wrapper cannot be used in current_thread runtimes

Implementations

impl AsyncStreamDeck

Static functions of the struct

pub fn connect( hidapi: &HidApi, kind: Kind, serial: &str, ) -> Result<AsyncStreamDeck, StreamDeckError>

Attempts to connect to the device, can be safely ran inside multi_thread runtime

impl AsyncStreamDeck

Instance methods of the struct

pub fn kind(&self) -> Kind

Returns kind of the Stream Deck

pub async fn manufacturer(&self) -> Result<String, StreamDeckError>

Returns manufacturer string of the device

pub async fn product(&self) -> Result<String, StreamDeckError>

Returns product string of the device

pub async fn serial_number(&self) -> Result<String, StreamDeckError>

Returns serial number of the device

pub async fn firmware_version(&self) -> Result<String, StreamDeckError>

Returns firmware version of the StreamDeck

pub async fn read_input( &self, poll_rate: f32, ) -> Result<StreamDeckInput, StreamDeckError>

Reads button states, awaits until there’s data. Poll rate determines how often button state gets checked

pub async fn reset(&self) -> Result<(), StreamDeckError>

Resets the device

pub async fn set_brightness(&self, percent: u8) -> Result<(), StreamDeckError>

Sets brightness of the device, value range is 0 - 100

pub async fn write_image( &self, key: u8, image_data: &[u8], ) -> Result<(), StreamDeckError>

Writes image data to Stream Deck device, changes must be flushed with .flush() before they will appear on the device!

pub async fn write_lcd( &self, x: u16, y: u16, rect: &ImageRect, ) -> Result<(), StreamDeckError>

Writes image data to Stream Deck device’s lcd strip/screen as region. Only Stream Deck Plus supports writing LCD regions, for Stream Deck Neo use write_lcd_fill

pub async fn write_lcd_fill( &self, image_data: &[u8], ) -> Result<(), StreamDeckError>

Writes image data to Stream Deck device’s lcd strip/screen as full fill

You can convert your images into proper image_data like this:

use elgato_streamdeck::images::{convert_image_with_format_async};
let image_data = convert_image_with_format_async(device.kind().lcd_image_format(), image).await.unwrap();
device.write_lcd_fill(&image_data).await;

pub async fn clear_button_image(&self, key: u8) -> Result<(), StreamDeckError>

Sets button’s image to blank, changes must be flushed with .flush() before they will appear on the device!

pub async fn clear_all_button_images(&self) -> Result<(), StreamDeckError>

Sets blank images to every button, changes must be flushed with .flush() before they will appear on the device!

pub async fn set_button_image( &self, key: u8, image: DynamicImage, ) -> Result<(), StreamDeckError>

Sets specified button’s image, changes must be flushed with .flush() before they will appear on the device!

pub async fn set_logo_image( &self, image: DynamicImage, ) -> Result<(), StreamDeckError>

Set logo image

pub async fn set_touchpoint_color( &self, point: u8, red: u8, green: u8, blue: u8, ) -> Result<(), StreamDeckError>

Sets specified touch point’s led strip color

pub async fn sleep(&self) -> Result<(), StreamDeckError>

Sleeps the device

pub async fn keep_alive(&self) -> Result<(), StreamDeckError>

Make periodic events to the device, to keep it alive

pub async fn shutdown(&self) -> Result<(), StreamDeckError>

Shutdown the device

pub async fn flush(&self) -> Result<(), StreamDeckError>

Flushes the button’s image to the device

pub fn get_reader(&self) -> Arc<AsyncDeviceStateReader>

Returns button state reader for this device

Trait Implementations

impl Clone for AsyncStreamDeck

fn clone(&self) -> AsyncStreamDeck

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.