Interface ShowStyleBlueprintManifest<TRawConfig, TProcessedConfig>

Apply 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

Execute an action defined by an IBlueprintActionManifest

Execute an action defined by an IBlueprintActionManifest.

This callback allows an action to perform operations only on the Timeline Datastore. This allows for a fast-path for rapid-fire actions, before the full executeAction callback resolves. For more information on how to use this callback, see "Timeline Datastore" in Sofie TV Automation Documentation for Blueprint Developers.

Called just before onTimelineGenerate to perform AB-playback for the timeline

Generate adlib piece from ingest data

Called just before taking the next part. This generates some persisted data used by onTimelineGenerate to modify the timeline based on the previous part (eg, persist audio levels)

Generate rundown from ingest data. return null to ignore that rundown

Generate segment from ingest data

Returns the id of the show style variant to use for a rundown, return null to ignore that rundown

Called after a Take action

Called when the Rundown data changes, to be able to update any queued external messages

Called when the timing for a PartInstance or its content changes. This will often be batched (via a short debounce), but is called for each part when either the part or a piece timing changes.

Called after the timeline has been generated, used to manipulate the timeline

Preprocess config before storing it by core to later be returned by context's getShowStyleConfig. If not provided, getShowStyleConfig will return unprocessed blueprint config

Allows the blueprint to custom-modify the PartInstance, on ingest data update (this is run after getSegment())

playStatus: previous means that the currentPartInstance is orphaned: adlib-part and thus possibly depends on an already past PartInstance for some of it's properties. Therefore the blueprint is allowed to modify the most recently played non-adlibbed PartInstance using ingested data.

newData.part will be undefined when the PartInstance is orphaned. Generally, it's useful to differentiate the behavior of the implementation of this function based on existingPartInstance.partInstance.orphaned state

Validate 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.