Struct streamdeck::StreamDeck

pub struct StreamDeck { /* fields omitted */ }

StreamDeck object

Methods

impl StreamDeck

pub fn connect(
    vid: u16,
    pid: u16,
    serial: Option<String>
) -> Result<StreamDeck, Error>

Connect to a streamdeck device

pub fn kind(&self) -> Kind

Fetch the connected device kind

This can be used to retrieve related device information such as images sizes and modes

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

Fetch the device manufacturer string

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

Fetch the device product string

pub fn serial(&mut self) -> Result<String, Error>

Fetch the device serial

pub fn version(&mut self) -> Result<String, Error>

Fetch the device firmware version

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

Reset the connected device

pub fn set_brightness(&mut self, brightness: u8) -> Result<(), Error>

Set the device display brightness (in percent)

pub fn set_blocking(&mut self, blocking: bool) -> Result<(), Error>

Set blocking mode

See: read_buttons for discussion of this functionality

pub fn read_buttons(
    &mut self,
    timeout: Option<Duration>
) -> Result<Vec<u8>, Error>

Fetch button states

In blocking mode this will wait until a report packet has been received (or the specified timeout has elapsed). In non-blocking mode this will return immediately with a zero vector if no data is available

pub fn image_size(&self) -> (usize, usize)

Fetch image size for the connected device

pub fn set_button_rgb(&mut self, key: u8, colour: &Colour) -> Result<(), Error>

Set a button to the provided RGB colour

pub fn set_button_image(&mut self, key: u8, image: &[u8]) -> Result<(), Error>

Set a button to the provided image

Images in BGR format, IMAGE_X by IMAGE_Y at 3 bytes per pixel

pub fn set_button_file(
    &mut self,
    key: u8,
    image: &str,
    opts: &ImageOptions
) -> Result<(), Error>