Documentation
¶
Index ¶
- Constants
- Variables
- func IsMediaLaunchingCommand(cmdName string) bool
- func IsValidCommand(cmdName string) bool
- func ParseAdvArgs[T any](pl platforms.Platform, env *platforms.CmdEnv, dest *T) error
- func PreWarmZapLinkHosts(db *database.Database, platform string, checkInternet func(int) bool)
- func RunCommand(pl platforms.Platform, cfg *config.Instance, plsc playlists.PlaylistController, ...) (platforms.CmdResult, error)
- type ArgPlaylist
- type ArgPlaylistItem
- type ExprEnvOptions
- type WellKnown
Constants ¶
const ( MIMEZaparooZapScript = "application/vnd.zaparoo.zapscript" WellKnownPath = "/.well-known/zaparoo" HeaderZaparooOS = "Zaparoo-OS" HeaderZaparooArch = "Zaparoo-Arch" HeaderZaparooPlatform = "Zaparoo-Platform" )
const ExecuteTimeout = 2 * time.Second
ExecuteTimeout is the maximum duration for execute commands.
Variables ¶
var ( ErrArgCount = errors.New("invalid number of arguments") ErrRequiredArgs = errors.New("arguments are required") ErrRemoteSource = errors.New("cannot run from remote source") ErrFileNotFound = errors.New("file not found") )
var AcceptedMimeTypes = []string{ MIMEZaparooZapScript, }
Functions ¶
func IsMediaLaunchingCommand ¶ added in v2.7.0
IsMediaLaunchingCommand returns true if the command launches media and should be subject to playtime limits. This includes all launch.* commands, most playlist commands (play/next/prev/goto/load/open), and mister.mgl.
func IsValidCommand ¶ added in v2.9.0
IsValidCommand returns true if the command name is a valid ZapScript command.
func ParseAdvArgs ¶ added in v2.8.0
ParseAdvArgs parses and validates advanced arguments for a command. Returns an error if parsing or validation fails.
func PreWarmZapLinkHosts ¶ added in v2.8.0
PreWarmZapLinkHosts pre-warms the DNS and TLS cache for known zaplink hosts. This is called during startup to reduce latency on first zaplink access. It makes HEAD requests to /.well-known/zaparoo for each supported base URL.
func RunCommand ¶
func RunCommand( pl platforms.Platform, cfg *config.Instance, plsc playlists.PlaylistController, token tokens.Token, cmd zapscript.Command, totalCmds int, currentIndex int, db *database.Database, st *state.State, exprOpts *ExprEnvOptions, ) (platforms.CmdResult, error)
RunCommand parses and runs a single ZapScript command.
Types ¶
type ArgPlaylist ¶
type ArgPlaylist struct {
ID string `json:"id"`
Name string `json:"name"`
Items []ArgPlaylistItem `json:"items"`
}
type ArgPlaylistItem ¶
type ExprEnvOptions ¶ added in v2.8.0
type ExprEnvOptions struct {
Scanned *zapscript.ExprEnvScanned
Launching *zapscript.ExprEnvLaunching
InHookContext bool // prevents recursive hook execution
}
ExprEnvOptions provides optional context for expression environment.
Source Files
Directories