action

Documentation

Index

• type Action
• type ActionBase
  • func (a *ActionBase) ApplyConfig(config *yaml.Node, imageHelper controller.ImageHelper, ...) error
• type ActionWithIcon
  • func (a *ActionWithIcon) ApplyConfig(config *yaml.Node, imageHelper controller.ImageHelper, ...) error
  • func (a *ActionWithIcon) Render(force bool) (*streamdeck.ImageData, error)

Types

type Action

type Action interface {
	New() Action

	// When ApplyConfig is called, apply config
	// Your struct is expected to declare exported fields with YAML annotation
	// for config values
	ApplyConfig(config *yaml.Node, imageHelper controller.ImageHelper, ctrl controller.Controller) error

	Run(pressed bool) error
	Name() string

	// In Render, you can return a nil image to indicate the image hasn't changed since the last call
	// This will indicate to the renderer to not change the image
	//
	// If force is true, you must always return an image if the action has one available
	// Otherwsie, a blank image will be set
	Render(force bool) (*streamdeck.ImageData, error)
}

type ActionBase

type ActionBase struct {
	ImageHelper controller.ImageHelper
	Controller  controller.Controller
}

func (*ActionBase) ApplyConfig

func (a *ActionBase) ApplyConfig(config *yaml.Node, imageHelper controller.ImageHelper, ctrl controller.Controller) error

type ActionWithIcon

type ActionWithIcon struct {
	ActionBase
	Icon string `yaml:"icon"`
}

func (*ActionWithIcon) ApplyConfig

func (a *ActionWithIcon) ApplyConfig(config *yaml.Node, imageHelper controller.ImageHelper, ctrl controller.Controller) error

func (*ActionWithIcon) Render

func (a *ActionWithIcon) Render(force bool) (*streamdeck.ImageData, error)