infoscreenapi

Documentation

Index

• func CreateShowEndpoint(router *app.Router)
• func DeleteShowEndpoint(router *app.Router)
• func EnabledEndpoint(router *app.Router)
• func GetLayoutEndpoint(router *app.Router)
• func GetShowEndpoint(router *app.Router)
• func ListLayoutNamesEndpoint(router *app.Router)
• func ListShowsEndpoint(router *app.Router)
• func PlayShowEndpoint(router *app.Router)
• func RenderLayoutPreviewEndpoint(router *app.Router)
• func Setup(a *app.App, grp *echo.Group)
• func SetupPlayer(a *app.App, grp *echo.Group)
• func UploadFileEndpoint(router *app.Router)
• type PlayContext
• type PlaySlide

Functions

func CreateShowEndpoint

func CreateShowEndpoint(router *app.Router)

func DeleteShowEndpoint

func DeleteShowEndpoint(router *app.Router)

func EnabledEndpoint

func EnabledEndpoint(router *app.Router)

func GetLayoutEndpoint

func GetLayoutEndpoint(router *app.Router)

func GetShowEndpoint

func GetShowEndpoint(router *app.Router)

func ListLayoutNamesEndpoint

func ListLayoutNamesEndpoint(router *app.Router)

func ListShowsEndpoint

func ListShowsEndpoint(router *app.Router)

func PlayShowEndpoint

func PlayShowEndpoint(router *app.Router)

trunk-ignore(golangci-lint/cyclop)

func RenderLayoutPreviewEndpoint

func RenderLayoutPreviewEndpoint(router *app.Router)

trunk-ignore(golangci-lint/cyclop)

func Setup

func Setup(a *app.App, grp *echo.Group)

Setup defines all routes for the infoscreen API.

func SetupPlayer

func SetupPlayer(a *app.App, grp *echo.Group)

func UploadFileEndpoint

func UploadFileEndpoint(router *app.Router)

trunk-ignore(golangci-lint/cyclop)

Types

type PlayContext

type PlayContext struct {
	ShowName  string
	Embedded  bool
	Theme     string
	Slides    []PlaySlide
	AutoSlide bool
	Preview   bool
}

type PlaySlide

type PlaySlide struct {
	Duration    float64
	Content     template.HTML
	AutoAnimate string
	Background  string
}