widget

Documentation

Index

• Variables
• func MustSurvive(err error) struct{}
• func NewRegistry(ctx context.Context, confs []map[string]any) types.WidgetRegistry
• func RegisterWidgetType(w Widget, tmplstring string) error
• type BaseWidget
  • func (w *BaseWidget) Actual() Widget
  • func (w *BaseWidget) Base() *BaseWidget
  • func (w *BaseWidget) Consume(ctx context.Context, event []byte) error
  • func (w *BaseWidget) Errorf(f string, args ...any) error
  • func (w *BaseWidget) Init(context.Context) error
  • func (w *BaseWidget) RenderTo(wr io.Writer) error
  • func (w *BaseWidget) Send(msg string) error
• type Button
  • func (w *Button) Consume(ctx context.Context, event []byte) error
  • func (w *Button) Init(context.Context) error
• type ButtonArgs
• type Clock
  • func (w *Clock) Init(ctx context.Context) error
• type Config
• type HrBr
• type Label
• type ObsRecord
  • func (w *ObsRecord) Consume(ctx context.Context, event []byte) error
  • func (w *ObsRecord) Init(ctx context.Context) error
• type ObsRecordInfo
• type ObsStream
  • func (w *ObsStream) Init(ctx context.Context) error
• type ObsStreamInfo
• type Registry
  • func (r *Registry) Consume(ctx context.Context, b []byte)
  • func (r *Registry) RenderTo(ctx context.Context, wr io.Writer) error
  • func (r *Registry) SendChan() chan string
• type Widget
  • func New(ctx context.Context, cfg Config) Widget

Variables

var SendChan = make(chan string)

var TemplateRegistry = make(map[string]*template.Template) // typename => html.template

var TypeRegistry = make(map[string]reflect.Type) // typename => widgettype

Functions

func MustSurvive

func MustSurvive(err error) struct{}

func NewRegistry

func NewRegistry(ctx context.Context, confs []map[string]any) types.WidgetRegistry

func RegisterWidgetType

func RegisterWidgetType(w Widget, tmplstring string) error

Types

type BaseWidget

type BaseWidget struct {
	Config
	Widget Widget
}

func (*BaseWidget) Actual

func (w *BaseWidget) Actual() Widget

func (*BaseWidget) Base

func (w *BaseWidget) Base() *BaseWidget

func (*BaseWidget) Consume

func (w *BaseWidget) Consume(ctx context.Context, event []byte) error

Consume websocket message in separate goroutine

func (*BaseWidget) Errorf

func (w *BaseWidget) Errorf(f string, args ...any) error

func (*BaseWidget) Init

func (w *BaseWidget) Init(context.Context) error

func (*BaseWidget) RenderTo

func (w *BaseWidget) RenderTo(wr io.Writer) error

func (*BaseWidget) Send

func (w *BaseWidget) Send(msg string) error

type Button

type Button struct {
	BaseWidget
	Args ButtonArgs
}

func (*Button) Consume

func (w *Button) Consume(ctx context.Context, event []byte) error

func (*Button) Init

func (w *Button) Init(context.Context) error

type ButtonArgs

type ButtonArgs struct {
	Action string
	Sound  string
}

type Clock

type Clock struct {
	BaseWidget
	Format string
}

func (*Clock) Init

func (w *Clock) Init(ctx context.Context) error

type Config

type Config struct {
	Name    string // Unique widget id
	Type    string // Type of widget class
	Caption string // Text to render in widget if it is a button or something like this
	Args    any    // Widget specific config
}

type HrBr

type HrBr struct {
	BaseWidget
}

type Label

type Label struct {
	BaseWidget
}

type ObsRecord

type ObsRecord struct {
	BaseWidget
}

func (*ObsRecord) Consume

func (w *ObsRecord) Consume(ctx context.Context, event []byte) error

func (*ObsRecord) Init

func (w *ObsRecord) Init(ctx context.Context) error

type ObsRecordInfo

type ObsRecordInfo struct {
	Rec    bool
	Pause  bool
	Length string
}

type ObsStream

type ObsStream struct {
	BaseWidget
}

func (*ObsStream) Init

func (w *ObsStream) Init(ctx context.Context) error

type ObsStreamInfo

type ObsStreamInfo struct {
	Active     bool
	Reconnect  bool
	Congestion float64
	Length     string
}

type Registry

type Registry struct {
	Map   map[string]Widget // Registered widgets
	Order []string          // order which widgets was in config
}

all of initialized widgets (from config)

func (*Registry) Consume

func (r *Registry) Consume(ctx context.Context, b []byte)

func (*Registry) RenderTo

func (r *Registry) RenderTo(ctx context.Context, wr io.Writer) error

func (*Registry) SendChan

func (r *Registry) SendChan() chan string

type Widget

type Widget interface {
	Init(ctx context.Context) error                  // init widget with config in it's base
	RenderTo(writer io.Writer) error                 // render visual representation
	Consume(ctx context.Context, event []byte) error // consume one event from Websocket
	Send(event string) error                         // Send something to all my visual representations
	Base() *BaseWidget                               // access to common data
	Actual() Widget                                  // pointer to actual widget
}

func New

func New(ctx context.Context, cfg Config) Widget