Struct streamdeck::StreamDeck

pub struct StreamDeck { /* private fields */ }

StreamDeck object

Implementations

impl StreamDeck

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

Connect to a streamdeck device

pub fn connect_with_hid( api: &HidApi, vid: u16, pid: u16, serial: Option<String> ) -> Result<StreamDeck, Error>

Connect to a streamdeck device with an already initialise HidApi instance

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: DynamicImage ) -> Result<(), Error>

Set a button to the provided image

pub fn set_button_text( &mut self, key: u8, font: &FontRef<'_>, pos: &TextPosition, text: &str, opts: &TextOptions ) -> Result<(), Error>

Sets a button to the provided text. Will break text over \n linebreaks

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

Set a button to the provided image file

pub fn load_image( &self, image: &str, opts: &ImageOptions ) -> Result<DeviceImage, Error>

Load an image file into the device specific representation

pub fn write_button_image( &mut self, key: u8, image: &DeviceImage ) -> Result<(), Error>

Writes an image to a button Image at this point in correct dimensions and in device native colour order.