Struct streamduck_core::core::SDCore

pub struct SDCore {
    pub module_manager: Arc<ModuleManager>,
    pub current_stack: Mutex<Vec<ButtonPanel>>,
    pub image_size: (usize, usize),
    pub image_collection: ImageCollection,
    pub key_count: u8,
    pub pool_rate: u32,
    pub should_close: RwLock<bool>,
    /* private fields */
}

Core struct that contains all relevant information about streamdeck and manages the streamdeck

Fields

module_manager: Arc<ModuleManager>

Module manager

current_stack: Mutex<Vec<ButtonPanel>>

Current panel stack

image_size: (usize, usize)

Image size supported by streamdeck

image_collection: ImageCollection

Image collection to use for rendering

key_count: u8

Key count of the streamdeck device

pool_rate: u32

Pool rate of how often should the core read events from the device

should_close: RwLock<bool>

Decides if core is dead

Implementations

impl SDCore

pub fn blank(
    module_manager: Arc<ModuleManager>,
    image_collection: ImageCollection
) -> Arc<SDCore>

Creates an instance of core that is already dead

pub fn new(
    module_manager: Arc<ModuleManager>,
    image_collection: ImageCollection,
    connection: StreamDeck,
    pool_rate: u32
) -> (Arc<SDCore>, KeyHandler)

Creates an instance of the core over existing streamdeck connection

pub fn mark_for_redraw(&self)

Tells renderer’s thread it’s time to redraw

pub fn get_button_images(&self) -> HashMap<u8, DynamicImage>

Gets current images rendered on streamdeck

pub fn send_commands(&self, commands: Vec<StreamDeckCommand>)

Sends commands to streamdeck thread

pub fn is_closed(&self) -> bool

Checks if core is supposed to be closed

pub fn close(&self)

Kills the core and all the related threads