Struct streamdeck::StreamDeck

source · [−]

pub struct StreamDeck { /* private fields */ }

Expand description

StreamDeck object

Implementations

source

impl StreamDeck

source

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

Connect to a streamdeck device

source

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

source

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

source

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

Fetch the device manufacturer string

source

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

Fetch the device product string

source

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

Fetch the device serial

source

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

Fetch the device firmware version

source

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

Reset the connected device

source

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

Set the device display brightness (in percent)

source

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

Set blocking mode

See: read_buttons for discussion of this functionality

source

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

source

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

Fetch image size for the connected device

source

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

Set a button to the provided RGB colour

source

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

Set a button to the provided image

source

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

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

source

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

Set a button to the provided image file

source

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

Load an image file into the device specific representation

source

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.

Auto Trait Implementations

impl RefUnwindSafe for StreamDeck

impl Send for StreamDeck

impl !Sync for StreamDeck

impl Unpin for StreamDeck

impl UnwindSafe for StreamDeck

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<Src> ValueFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>

Convert the given value into an exactly equivalent representation.

impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,

type Err = <Dst as ValueFrom<Src>>::Err

The error type produced by a failed conversion.

fn value_into(self) -> Result<Dst, <Src as ValueInto<Dst>>::Err>

Convert the subject into an exactly equivalent representation.

Struct streamdeck::StreamDeck

Implementations

impl StreamDeck

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

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

pub fn kind(&self) -> Kind

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Auto Trait Implementations

impl RefUnwindSafe for StreamDeck

impl Send for StreamDeck

impl !Sync for StreamDeck

impl Unpin for StreamDeck

impl UnwindSafe for StreamDeck

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where Scheme: ApproxScheme,

type Err = NoError

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, DefaultApprox>,

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, DefaultApprox>,

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

fn into_as<Dst>(self) -> Dst where Self: Into<Dst>,

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where Self: TryInto<Dst>,

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where Self: ValueInto<Dst>,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<Src> TryFrom<Src> for Src

type Err = NoError

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<Src, Dst> TryInto<Dst> for Src where Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,