Interface StudioBlueprintManifest<TRawConfig, TProcessedConfig>

Type Parameters

Hierarchy

Properties

TSRVersion: string

Version of the TSR-types that the blueprint depend on

applyConfig?: ((context: ICommonContext, config: TRawConfig, coreConfig: BlueprintConfigCoreConfig) => BlueprintResultApplyStudioConfig)

Type declaration

blueprintId?: string

Unique id of the blueprint. This is used by core to check if blueprints are the same blueprint, but differing versions

blueprintType: STUDIO
blueprintVersion: string

Version of the blueprint

configPresets: Record<string, IStudioConfigPreset<TRawConfig>>

The config presets exposed by this blueprint

Type declaration

getRundownPlaylistInfo?: ((context: IStudioUserContext, rundowns: IBlueprintRundownDB<unknown>[], playlistExternalId: string) => null | BlueprintResultRundownPlaylist)

Type declaration

getShowStyleId: ((context: IStudioUserContext, showStyles: readonly ReadonlyObjectDeep<IBlueprintShowStyleBase>[], ingestRundown: ExtendedIngestRundown) => null | string)

Type declaration

integrationVersion: string

Version of the blueprint-integration that the blueprint depend on

preprocessConfig?: ((context: ICommonContext, config: TRawConfig, coreConfig: BlueprintConfigCoreConfig) => TProcessedConfig)

Type declaration

studioConfigSchema: JSONBlob<JSONSchema<any, JSONSchema.TypeValue>>

A list of config items this blueprint expects to be available on the Studio

studioMigrations: MigrationStepStudio[]

A list of Migration steps related to a Studio

translations?: string

Translations connected to the studio (as stringified JSON)

validateConfig?: ((context: ICommonContext, config: TRawConfig) => IConfigMessage[])

Type declaration

    • (context: ICommonContext, config: TRawConfig): IConfigMessage[]
    • 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.

      Parameters

      Returns IConfigMessage[]

Generated using TypeDoc