Functions — github.com/OpenActionAPI/rust-elgato-streamdeck

CodeHub MCPcopy Create free account

hub / github.com/OpenActionAPI/rust-elgato-streamdeck / functions

Functions83 in github.com/OpenActionAPI/rust-elgato-streamdeck

⨍ Functions 83 ◇ Types & classes 16

↓ 16 callersMethodkey_count

Amount of keys the Stream Deck kind has

src/info.rs:157

↓ 12 callersMethodkind

Returns kind of the Stream Deck

↓ 8 callersMethodlcd_image_format

Image format used by LCD screen, used for filling LCD

src/info.rs:278

↓ 6 callersFunctionconvert_image_with_format

Converts image into image data depending on provided image format

src/images.rs:17

↓ 6 callersFunctionextract_str

Extracts string from byte array, removing \0 symbols

↓ 6 callersFunctionget_feature_report

Performs get_feature_report on [HidDevice]

↓ 5 callersMethodread

Reads states and returns updates

↓ 5 callersFunctionsend_feature_report

Performs send_feature_report on [HidDevice]

↓ 4 callersMethodset_button_image

Sets specified button's image, changes must be flushed with `.flush()` before they will appear on the device!

↓ 4 callersMethodtouchpoint_count

Amount of touch points the Stream Deck kind has

src/info.rs:201

↓ 4 callersMethodwrite_image_data_reports

(&self, image_data: &[u8], parameters: WriteImageParameters, header_fn: T)

↓ 3 callersMethodcolumn_count

Amount of button columns the Stream Deck kind has

src/info.rs:180

↓ 3 callersMethodencoder_count

Amount of encoders/knobs the Stream Deck kind has

src/info.rs:192

↓ 3 callersMethodflush

Flushes the button's image to the device

↓ 3 callersMethodlcd_strip_size

Size of the LCD strip on the device

src/info.rs:209

↓ 3 callersFunctionlist_devices

Returns a list of devices as (Kind, Serial Number) that could be found using HidApi. WARNING:** To refresh the list, use [refresh_device_list]

↓ 3 callersFunctionread_data

Reads data from [HidDevice]. Blocking mode is used if timeout is specified

↓ 3 callersMethodvendor_id

Retrieves Vendor ID used by Elgato hardware

src/info.rs:135

↓ 2 callersMethodclear_all_button_images

Sets blank images to every button, changes must be flushed with `.flush()` before they will appear on the device!

↓ 2 callersFunctionconvert_image

Converts image into image data depending on provided kind of device

src/images.rs:12

↓ 2 callersFunctionflip_key_index

Flips key index horizontally, for use with Original v1 Stream Deck

↓ 2 callersMethodget_reader

Returns button state reader for this device

↓ 2 callersMethodis_empty

Checks if there's data received or not

↓ 2 callersMethodkey_image_format

Image format used by the Stream Deck kind

src/info.rs:229

↓ 2 callersFunctionnew_hidapi

Creates an instance of the HidApi Can be used if you don't want to link hidapi crate into your project

↓ 2 callersMethodproduct_id

Retrieves Product ID of the Stream Deck

src/info.rs:113

↓ 2 callersFunctionread_button_states

Reads button states, empty vector if no data

↓ 2 callersMethodsend_image

(&self, key: u8, image_data: &[u8])

↓ 2 callersMethodset_brightness

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

↓ 2 callersMethodset_touchpoint_color

Sets specified touch point's led strip color

↓ 2 callersMethodwrite_lcd

Writes image data to Stream Deck device's lcd strip/screen as region. Only Stream Deck Plus supports writing LCD regions, for Stream Deck Neo use writ

↓ 2 callersMethodwrite_lcd_fill

Writes image data to Stream Deck device's lcd strip/screen as full fill You can convert your images into proper image_data like this: ``` use elgato_

↓ 1 callersMethodblank_image

Returns blank image data appropriate for the Stream Deck kind

src/info.rs:303

↓ 1 callersMethodclear_button_image

Sets button's image to blank, changes must be flushed with `.flush()` before they will appear on the device!

↓ 1 callersFunctionconvert_image_async

(kind: Kind, image: DynamicImage)

src/images.rs:62

↓ 1 callersFunctionis_vendor_familiar

Returns true for vendors IDs that are recognized by the library

↓ 1 callersMethodis_visual

Tells if the Stream Deck kind has a screen

src/info.rs:219

↓ 1 callersMethodkind

Returns kind of the Stream Deck

src/asynchronous.rs:64

↓ 1 callersFunctionread_encoder_input

Reads encoder input

src/util.rs:100

↓ 1 callersMethodread_input

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

src/asynchronous.rs:94

↓ 1 callersMethodread_input

Reads all possible input from Stream Deck device

↓ 1 callersFunctionread_lcd_input

Reads lcd screen input

↓ 1 callersMethodrow_count

Amount of button rows the Stream Deck kind has

src/info.rs:169

↓ 1 callersMethodserial_number

Returns serial number of the device

↓ 1 callersFunctionwrite_data

Writes data to [HidDevice]

↓ 1 callersMethodwrite_image

Writes image data to Stream Deck device, changes must be flushed with `.flush()` before they will appear on the device!

src/asynchronous.rs:121

↓ 1 callersMethodwrite_image

Writes image data to Stream Deck device, changes must be flushed with `.flush()` before they will appear on the device!

Methodclear_all_button_images

Sets blank images to every button, changes must be flushed with `.flush()` before they will appear on the device!

src/asynchronous.rs:155

Methodclear_button_image

Sets button's image to blank, changes must be flushed with `.flush()` before they will appear on the device!

src/asynchronous.rs:148

Attempts to connect to the device, can be safely ran inside [multi_thread](tokio::runtime::Builder::new_multi_thread) runtime

src/asynchronous.rs:41

Attempts to connect to the device

Functionconvert_image_with_format_async

(format: ImageFormat, image: DynamicImage)

src/images.rs:69

src/info.rs:432

Methodfirmware_version

Returns firmware version of the StreamDeck

src/asynchronous.rs:87

Methodfirmware_version

Returns firmware version of the StreamDeck

Flushes the button's image to the device

src/asynchronous.rs:176

(&self, f: &mut Formatter<'_>)

(kind: Kind, image_data_len: usize)

Wraps an already-opened [StreamDeck], allowing the caller to control which thread performs the HID open

src/asynchronous.rs:53

Methodfrom_image

Converts image to image rect

src/images.rs:87

Methodfrom_image_async

(image: DynamicImage)

src/images.rs:106

Methodfrom_vid_pid

Creates [Kind] variant from Vendor ID and Product ID

Methodget_reader

Returns button state reader for this device

src/asynchronous.rs:182

Methodkey_layout

Key layout of the Stream Deck kind as (rows, columns)

src/info.rs:224

Functionlist_devices_async

Returns a list of devices as (Kind, Serial Number) that could be found using HidApi, can be safely ran inside [multi_thread](tokio::runtime::Builder::

src/asynchronous.rs:26

examples/async.rs:13

examples/simple.rs:10

Methodmanufacturer

Returns manufacturer string of the device

src/asynchronous.rs:69

Methodmanufacturer

Returns manufacturer string of the device

Returns product string of the device

src/asynchronous.rs:75

Returns product string of the device

Reads states and returns updates

src/asynchronous.rs:201

Functionrefresh_device_list

Actually refreshes the device list

Functionrefresh_device_list_async

Actually refreshes the device list, can be safely ran inside [multi_thread](tokio::runtime::Builder::new_multi_thread) runtime

src/asynchronous.rs:18

Resets the device

src/asynchronous.rs:108

Resets the device

Methodserial_number

Returns serial number of the device

src/asynchronous.rs:81

Methodset_brightness

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

src/asynchronous.rs:114

Methodset_button_image

Sets specified button's image, changes must be flushed with `.flush()` before they will appear on the device!

src/asynchronous.rs:162

Methodset_touchpoint_color

Sets specified touch point's led strip color

src/asynchronous.rs:170

Methodwrite_lcd

Writes image data to Stream Deck device's lcd strip/screen as region. Only Stream Deck Plus supports writing LCD regions, for Stream Deck Neo use writ

src/asynchronous.rs:128

Methodwrite_lcd_fill

Writes image data to Stream Deck device's lcd strip/screen as full fill You can convert your images into proper image_data like this: ``` use elgato_

src/asynchronous.rs:141