config
Description
The primary configuration object that triggers Maestro config fetch. This object is passed directly into each panel.
Type
assocArray
Usage
m.lib.config = {
siteID: "your-site-id",
eventID: "your-event-id",
pageID: "your-page-id",
authToken: "user-auth-token",
swid: "user-id",
useProdEnv: true
}
Config Fields
| Config Key | Type | Required | Description |
|---|---|---|---|
siteID | string | Yes | Environment identifier (client-level) |
eventID | string | No | Live or VOD event identifier |
pageID | string | No | ID associated with a Maestro Page |
authToken | string | No | User auth token |
swid | string | No | User ID |
useProdEnv | boolean | Yes | Choose production or QA API environment |
showHelloWorld | boolean | No | When true and useProdEnv is false, skips the panel-config fetch and mounts the debug panel directly. Use during development to render the debug panel without a valid panel config. |
client | string | No | Content delivery environment identifier. When provided, overrides the SDK-level default for this configuration request. |
note
The config object can be passed any parameter. This object is passed directly into each panel.
Each panel will have different requirements — it is up to you to pass what is needed.
siteID and at least one of eventID or pageID are required. Empty strings count as
missing — a config with empty required fields is rejected before any network request is made,
and the reason is reported on errorInformation.
danger
Always set all configurable fields BEFORE setting config. The config triggers API requests — any missing fields will not be applied afterward.
Example
sub onLibraryLoadStatusChanged()
if m.componentLibrary.loadStatus = "ready"
m.lib = createObject("roSGNode", "MaestroPanelLib:MaestroPanel")
' Set other configurable fields first
m.lib.width = 1280
m.lib.height = 720
m.lib.displayQRCodes = true
' Set config last to trigger initialization
m.lib.config = {
siteID: "your-site-id",
eventID: "your-event-id",
useProdEnv: true
}
m.top.appendChild(m.lib)
end if
end sub