Optional
applyApply the config by generating the data to be saved into the db. This should be written to give a predictable and stable result, it can be called with the same config multiple times
Optional
blueprintUnique id of the blueprint. This is used by core to check if blueprints are the same blueprint, but differing versions
Version of the blueprint
The config presets exposed by this blueprint
Returns the items used to build the baseline (default state) of a studio, this is the baseline used when there's no active rundown
Optional
getReturns information about the playlist this rundown is a part of, return null to not make it a part of a playlist
Returns the id of the show style to use for a rundown, return null to ignore that rundown
Version of the blueprint-integration that the blueprint depend on
Optional
preprocessPreprocess config before storing it by core to later be returned by context's getStudioConfig. If not provided, getStudioConfig will return unprocessed blueprint config
A list of config items this blueprint expects to be available on the Studio
A list of Migration steps related to a Studio
Optional
translationsTranslations connected to the studio (as stringified JSON)
Optional
validateValidate the config passed to this blueprint
In this you should do various sanity checks of the config and return a list of messages to display to the user.
These messages do not stop applyConfig
from being called.
Generated using TypeDoc
Version of the TSR-types that the blueprint depend on