Struct elgato_streamdeck::asynchronous::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 fn get_reader(&self) -> Arc<DeviceStateReader>

Returns button state reader for this device

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, needs to accept Arc for image data since it runs a blocking thread under the hood

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

Writes image data to Stream Deck device’s lcd strip/screen, needs to accept Arc for image data since it runs a blocking thread under the hood

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

Writes image data to Stream Deck device

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

Sets specified button’s image

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.