Commands and Functions

commands-and-functions_en.html

This is the “go here first” scripting catalog for people who need to know what can be automated.

Command groups

Core command expectations

• Commands must operate on explicit state rather than hidden UI assumptions.
• Command arguments must be deterministic and serializable.
• Commands must not bypass the canonical composition model.
• If a command can fail, the docs must explain how failure is surfaced.

Illustrative commands and functions

setThumbnail

setThumbnail({
  mode: "image" | "url-art",
  source: "https://example/image.png" | null,
  fitMode: "contain" | "cover-with-protected-content" | "outpaint-horizontal",
  altText: "optional descriptive text"
})

setQr

setQr({
  enabled: true,
  content: "https://example.com",
  position: "auto" | "top-right" | "custom",
  layerPolicy: "dedicated"
})

render

render({
  target: "live" | "export",
  resolution: { width: 8192, height: 4320 },
  colorMode: "default",
  language: "en"
})

exportImage

exportImage({
  format: "png" | "jpeg",
  qualityMode: "master" | "compact",
  requireQrParity: true
})

Scripting-specific fail conditions

• A command that causes export to diverge from the canonical layer order is invalid.
• A command path that depends on screen pixels rather than target output size is invalid.
• If command docs omit arguments or defaults that materially affect output, the command docs are incomplete.