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

Implementations

impl AsyncStreamDeck

Static functions of the struct

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

Attempts to connect to the device

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_button_states(
    &self,
    poll_rate: f32
) -> Result<Vec<bool>, StreamDeckError>

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

pub fn get_reader(self: &Arc<Self>) -> Arc<ButtonStateReader>

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

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