Introduction
Documentation for this page is yet to be written.
Blueprints are JavaScript programs that run inside Sofie Core and interpret data coming in from the Rundowns and transform that into playable elements. They use an API published in @sofie-automation/blueprints-integration TypeScript library to expose their functionality and communicate with Sofie Core.
Technically, a Blueprint is a JavaScript object, implementing one of the BlueprintManifestBase interfaces.
Sofie doesn't have a built-in package manager or import, so all dependencies need to be bundled into a single *.js file bundle using a bundler such as Rollup or webpack. The community has built a set of utilities called SuperFlyTV/sofie-blueprint-tools that acts as a nascent framework for building & bundling Blueprints written in TypeScript.
Note that the Runtime Environment for Blueprints in Sofie is plain JavaScript at ES2015 level, so other ways of building Blueprints are also possible.
Currently, there are three types of Blueprints:
- Show Style Blueprints - handling converting NRCS Rundown data into Sofie Rundowns and content.
- Studio Blueprints - handling selecting ShowStyles for a given NRCS Rundown and assigning NRCS Rundowns to Sofie Playlists
- System Blueprints - handling system provisioning and global configuration
Show Style Blueprints
These blueprints interpret the data coming from the NRCS, meaning that they need to support the particular data structures that a given Ingest Gateway uses to store incoming data from the Rundown editor. They will need to convert Rundown Pages, Cues, Items, pieces of show script and other types of objects into Sofie concepts such as Segments, Parts, Pieces and AdLibs.
Studio Blueprints
These blueprints provide a "baseline" Timeline that is being used by your Studio whenever there isn't a Rundown active. They also handle combining Rundowns into RundownPlaylists. Via the applyConfig method, these Blueprints enable a Configuration-as-Code approach to configuring connections to various elements of your Control Room and Studio.
System Blueprints
These blueprints exist to allow a Configuration-as-Code approach to an entire Sofie system. This is done via the applyConfig providing personality information such as global system configuration or system-wide HotKeys via the Blueprints.