Struct elgato_streamdeck::StreamDeck

pub struct StreamDeck { /* private fields */ }

Interface for a Stream Deck device

Implementations

impl StreamDeck

Static functions of the struct

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

Attempts to connect to the device

impl StreamDeck

Instance methods of the struct

pub fn kind(&self) -> Kind

Returns kind of the Stream Deck

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

Returns manufacturer string of the device

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

Returns product string of the device

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

Returns serial number of the device

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

Returns firmware version of the StreamDeck

pub fn read_button_states(
    &self,
    timeout: Option<Duration>
) -> Result<Vec<bool>, StreamDeckError>

Reads button states, empty vector if no data. Non-blocking if no timeout

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

Resets the device

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

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

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

Writes image data to Stream Deck device

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

Sets button’s image to blank

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

Sets specified button’s image