Struct streamduck_core::config::Config

pub struct Config {
    pub plugin_settings: RwLock<HashMap<String, Value>>,
    pub loaded_configs: RwLock<HashMap<String, UniqueDeviceConfig>>,
    pub loaded_images: RwLock<HashMap<String, ImageCollection>>,
    /* private fields */
}

Struct to keep daemon settings

Fields

plugin_settings: RwLock<HashMap<String, Value>>

loaded_configs: RwLock<HashMap<String, UniqueDeviceConfig>>

Currently loaded device configs

loaded_images: RwLock<HashMap<String, ImageCollection>>

Currently loaded image collections

Implementations

impl Config

pub fn get() -> Config

Reads config and retrieves config struct

pub fn frame_rate(&self) -> u32

Pool rate, defaults to DEFAULT_FRAME_RATE if not set

pub fn reconnect_rate(&self) -> f32

Reconnect rate, defaults to DEFAULT_RECONNECT_TIME if not set

pub fn device_config_path(&self) -> PathBuf

Device config path, defaults to DEFAULT_CONFIG_PATH if not set

pub fn plugin_path(&self) -> PathBuf

Plugin folder path, defaults to DEFAULT_PLUGIN_PATH if not set

pub fn plugin_settings_path(&self) -> PathBuf

Global config path, defaults to DEFAULT_PLUGIN_SETTINGS_PATH if not set

pub fn load_plugin_settings(&self)

Loads plugin settings from file

pub fn get_plugin_settings<T: PluginConfig + DeserializeOwned>(
    &self
) -> Option<T>

Retrieves plugin settings if it exists

pub fn set_plugin_settings<T: PluginConfig + Serialize>(&self, value: T)

Sets plugin settings

pub fn write_plugin_settings(&self)

Writes plugin settings to file

pub fn reload_device_config(&self, serial: &str) -> Result<(), ConfigError>

Reloads device config for specified serial

pub fn reload_device_configs(&self) -> Result<(), ConfigError>

Reloads all device configs

pub fn save_device_config(&self, serial: &str) -> Result<(), ConfigError>

Saves device config for specified serial

pub fn save_device_configs(&self) -> Result<(), ConfigError>

Saves device configs for all serials

pub fn get_device_config(&self, serial: &str) -> Option<UniqueDeviceConfig>

Retrieves device config for specified serial

pub fn set_device_config(&self, serial: &str, config: DeviceConfig)

Sets device config for specified serial

pub fn get_all_device_configs(&self) -> Vec<UniqueDeviceConfig>

Gets an array of all device configs

pub fn disable_device_config(&self, serial: &str) -> bool

Disables a device config, so it will not be loaded by default

pub fn restore_device_config(&self, serial: &str) -> bool

Restores device config if it exists

pub fn add_image(&self, serial: &str, image: String) -> Option<String>

Adds base64 image to device config image collection

pub fn add_image_encode(
    &self,
    serial: &str,
    image: DynamicImage
) -> Option<String>

Encodes image to base64 and adds it to device config image collection

pub fn get_images(
    &self,
    serial: &str
) -> Option<HashMap<String, SDSerializedImage>>

Gets images from device config

pub fn remove_image(&self, serial: &str, identifier: &str) -> bool

Removes image from device config

pub fn sync_images(&self, serial: &str)

Syncs images with core

pub fn get_image_collection(&self, serial: &str) -> ImageCollection

Retrieves image collection for device if device exists

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.