config

Documentation

Index

• type Config
  • func (c *Config) ConfigWithOverrides(queries url.Values) Config
  • func (c *Config) Load() error

Types

type Config

type Config struct {
	// ImmichApiKey Immich key to access assets
	ImmichApiKey string `mapstructure:"immich_api_key"`
	// ImmichUrl Immuch base url
	ImmichUrl string `mapstructure:"immich_url"`

	// DisableUi a shortcut to disable ShowTime, ShowDate, ShowImageTime and ShowImageDate
	DisableUi bool

	// ShowTime whether to display clock
	ShowTime bool `mapstructure:"show_time"`
	// TimeFormat whether to use 12 of 24 hour format for clock
	TimeFormat string `mapstructure:"time_format"`
	// ShowDate whether to display date
	ShowDate bool `mapstructure:"show_date"`
	//  DateFormat format for date
	DateFormat string `mapstructure:"date_format"`

	// Refresh time between fetching new image
	Refresh int `mapstructure:"refresh"`
	// Person ID of person to display
	Person []string `mapstructure:"person"`
	// Album ID of album to display
	Album string `mapstructure:"album"`
	// FillScreen force image to be fullscreen
	FillScreen bool `mapstructure:"fill_screen"`

	// BackgroundBlur whether to display blurred image as background
	BackgroundBlur bool `mapstructure:"background_blur"`
	// BackgroundBlur which transition to use none|fade|cross-fade
	Transition string `mapstructure:"transition"`
	// ShowProgress display a progress bar
	ShowProgress bool `mapstructure:"show_progress"`

	// ShowImageTime whether to display image time
	ShowImageTime bool `mapstructure:"show_image_time"`
	// ImageTimeFormat  whether to use 12 of 24 hour format
	ImageTimeFormat string `mapstructure:"image_time_format"`
	// ShowImageDate whether to display image date
	ShowImageDate bool `mapstructure:"show_image_date"`
	// ImageDateFormat format for image date
	ImageDateFormat string `mapstructure:"image_date_format"`
}

func (*Config) ConfigWithOverrides

func (c *Config) ConfigWithOverrides(queries url.Values) Config

ConfigWithOverrides overwrites base config with ones supplied via URL queries

func (*Config) Load

func (c *Config) Load() error

Load loads config file