Allow control from config and blueprints

Author: rjmunro

packages/blueprints-integration/src/documents/piece.ts

@@ -45,6 +45,12 @@ export interface IBlueprintPiece<TPrivateData = unknown, TPublicData = unknown>
 	 * Whether to stop this piece before the 'keepalive' period of the part
 	 */
 	excludeDuringPartKeepalive?: boolean
+
+	/**
+	 * Whether to display AB resolver channel assignment on Director screen.
+	 * If set, overrides show style configuration for this piece.
+	 */
+	displayAbChannel?: boolean
 }
 export interface IBlueprintPieceDB<TPrivateData = unknown, TPublicData = unknown>
 	extends IBlueprintPiece<TPrivateData, TPublicData> {

packages/corelib/src/dataModel/ShowStyleBase.ts

@@ -48,6 +48,19 @@ export interface DBShowStyleBase {
 	/** Config values are used by the Blueprints */
 	blueprintConfigWithOverrides: ObjectWithOverrides<IBlueprintConfig>
 
+	/** Configuration for displaying AB resolver channel assignments across different screens */
+	abChannelDisplay?: {
+		/** Source layer IDs that should show AB channel info */
+		sourceLayerIds: string[]
+		/** Configure by source layer type */
+		sourceLayerTypes: SourceLayerType[]
+		/** Only show for specific output layers (e.g., only PGM) */
+		outputLayerIds: string[]
+		/** Enable display on Director screen */
+		showOnDirectorScreen: boolean
+		// Future: showOnPresenterScreen, showOnCameraScreen when those views are implemented
+	}
+
 	_rundownVersionHash: string
 
 	/** Details on the last blueprint used to generate the defaults values for this */

packages/meteor-lib/src/api/showStyles.ts

@@ -1,5 +1,10 @@
 import { ShowStyleBaseId, ShowStyleVariantId, StudioId } from '@sofie-automation/corelib/dist/dataModel/Ids'
-import { HotkeyDefinition, OutputLayers, SourceLayers } from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
+import {
+	HotkeyDefinition,
+	OutputLayers,
+	SourceLayers,
+	type DBShowStyleBase,
+} from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
 import { DBShowStyleVariant } from '@sofie-automation/corelib/dist/dataModel/ShowStyleVariant'
 
 export interface NewShowStylesAPI {
@@ -44,6 +49,9 @@ export interface UIShowStyleBase {
 	outputLayers: OutputLayers
 	/** "Layers" in the GUI */
 	sourceLayers: SourceLayers
+
+	/** Configuration for displaying AB resolver channels on various screens */
+	abChannelDisplay?: DBShowStyleBase['abChannelDisplay']
 }
 
 export interface CreateAdlibTestingRundownOption {

packages/webui/src/client/ui/ClockView/DirectorScreen.tsx

@@ -54,11 +54,65 @@ import {
 import { AdjustLabelFit } from '../util/AdjustLabelFit.js'
 import { AutoNextStatus } from '../RundownView/RundownTiming/AutoNextStatus.js'
 import { useTranslation } from 'react-i18next'
+import { DBShowStyleBase } from '@sofie-automation/corelib/dist/dataModel/ShowStyleBase'
+import { PieceInstance } from '@sofie-automation/corelib/dist/dataModel/PieceInstance.js'
 
 interface SegmentUi extends DBSegment {
 	items: Array<PartUi>
 }
 
+/**
+ * Determines whether a piece instance should display its AB resolver channel assignment on the Director screen.
+ * Checks piece-level override first, then falls back to show style configuration.
+ * Note: Future screens (presenter, camera) will have their own showOn* flags when implemented.
+ */
+function shouldDisplayAbChannel(
+	pieceInstance: PieceInstance,
+	showStyleBase: UIShowStyleBase,
+	config?: DBShowStyleBase['abChannelDisplay']
+): boolean {
+	// Check piece-level override first (from blueprint)
+	const piece = pieceInstance.piece as any
+	if (piece.displayAbChannel !== undefined) {
+		return piece.displayAbChannel
+	}
+
+	// If no config, use sensible defaults but don't show (screen flag defaults to false)
+	const effectiveConfig: NonNullable<DBShowStyleBase['abChannelDisplay']> = config ?? {
+		// Default: guess VT and LIVE_SPEAK types
+		sourceLayerIds: [],
+		sourceLayerTypes: [SourceLayerType.VT, SourceLayerType.LIVE_SPEAK],
+		outputLayerIds: [],
+
+		// But don't show by default
+		showOnDirectorScreen: false,
+	}
+
+	// Check if display is enabled for director screen
+	if (!effectiveConfig.showOnDirectorScreen) return false
+
+	const sourceLayer = showStyleBase.sourceLayers?.[pieceInstance.piece.sourceLayerId]
+
+	// Check if output layer filter is specified and doesn't match
+	if (effectiveConfig.outputLayerIds.length > 0) {
+		if (!effectiveConfig.outputLayerIds.includes(pieceInstance.piece.outputLayerId)) {
+			return false
+		}
+	}
+
+	// Check if source layer ID is explicitly listed
+	if (effectiveConfig.sourceLayerIds.includes(pieceInstance.piece.sourceLayerId)) {
+		return true
+	}
+
+	// Check sourceLayer type match
+	if (sourceLayer?.type && effectiveConfig.sourceLayerTypes.includes(sourceLayer.type)) {
+		return true
+	}
+
+	return false
+}
+
 interface TimeMap {
 	[key: string]: number
 }
@@ -393,33 +447,31 @@ function DirectorScreenRender({
 			)
 		}
 
-		// Compute current and next clip player ids (for VT pieces)
+		// Compute current and next clip player ids (for pieces with AB sessions)
 		const currentClipPlayer: string | undefined = useTracker(() => {
 			if (!currentPartInstance || !currentShowStyleBase || !playlist?.assignedAbSessions) return undefined
+			const config = currentShowStyleBase.abChannelDisplay
 			const instances = PieceInstances.find({
 				partInstanceId: currentPartInstance.instance._id,
 				reset: { $ne: true },
 			}).fetch()
 			for (const pi of instances) {
-				const sl = currentShowStyleBase.sourceLayers?.[pi.piece.sourceLayerId]
-				// Only consider VT and LIVE_SPEAK on the PGM output layer
-				const ol = currentShowStyleBase.outputLayers?.[pi.piece.outputLayerId]
-				if ((sl?.type === SourceLayerType.VT || sl?.type === SourceLayerType.LIVE_SPEAK) && ol?.isPGM) {
-					const ab = pi.piece.abSessions
-					if (!ab || ab.length === 0) continue
-					for (const s of ab) {
-						const pool = playlist.assignedAbSessions?.[s.poolName]
-						if (!pool) continue
-						const matches: ABSessionAssignment[] = []
-						for (const key in pool) {
-							const a = pool[key]
-							if (a && a.sessionName === s.sessionName) matches.push(a)
-						}
-						const live = matches.find((m) => !m.lookahead)
-						const la = matches.find((m) => m.lookahead)
-						if (live) return String(live.playerId)
-						if (la) return String(la.playerId)
+				// Use configuration to determine if this piece should display AB channel
+				if (!shouldDisplayAbChannel(pi, currentShowStyleBase, config)) continue
+				const ab = pi.piece.abSessions
+				if (!ab || ab.length === 0) continue
+				for (const s of ab) {
+					const pool = playlist.assignedAbSessions?.[s.poolName]
+					if (!pool) continue
+					const matches: ABSessionAssignment[] = []
+					for (const key in pool) {
+						const a = pool[key]
+						if (a && a.sessionName === s.sessionName) matches.push(a)
 					}
+					const live = matches.find((m) => !m.lookahead)
+					const la = matches.find((m) => m.lookahead)
+					if (live) return String(live.playerId)
+					if (la) return String(la.playerId)
 				}
 			}
 			return undefined
@@ -430,30 +482,28 @@ function DirectorScreenRender({
 			// We need the ShowStyleBase to resolve sourceLayer types
 			const ssb = UIShowStyleBases.findOne(nextShowStyleBaseId)
 			if (!ssb) return undefined
+			const config = ssb.abChannelDisplay
 			const instances = PieceInstances.find({
 				partInstanceId: nextPartInstance.instance._id,
 				reset: { $ne: true },
 			}).fetch()
 			for (const pi of instances) {
-				const sl = ssb.sourceLayers?.[pi.piece.sourceLayerId]
-				// Only consider VT and LIVE_SPEAK on the PGM output layer
-				const ol = ssb.outputLayers?.[pi.piece.outputLayerId]
-				if ((sl?.type === SourceLayerType.VT || sl?.type === SourceLayerType.LIVE_SPEAK) && ol?.isPGM) {
-					const ab = pi.piece.abSessions
-					if (!ab || ab.length === 0) continue
-					for (const s of ab) {
-						const pool = playlist.assignedAbSessions?.[s.poolName]
-						if (!pool) continue
-						const matches: ABSessionAssignment[] = []
-						for (const key in pool) {
-							const a = pool[key]
-							if (a && a.sessionName === s.sessionName) matches.push(a)
-						}
-						const live = matches.find((m) => !m.lookahead)
-						const la = matches.find((m) => m.lookahead)
-						if (live) return String(live.playerId)
-						if (la) return String(la.playerId)
+				// Use configuration to determine if this piece should display AB channel
+				if (!shouldDisplayAbChannel(pi, ssb, config)) continue
+				const ab = pi.piece.abSessions
+				if (!ab || ab.length === 0) continue
+				for (const s of ab) {
+					const pool = playlist.assignedAbSessions?.[s.poolName]
+					if (!pool) continue
+					const matches: ABSessionAssignment[] = []
+					for (const key in pool) {
+						const a = pool[key]
+						if (a && a.sessionName === s.sessionName) matches.push(a)
 					}
+					const live = matches.find((m) => !m.lookahead)
+					const la = matches.find((m) => m.lookahead)
+					if (live) return String(live.playerId)
+					if (la) return String(la.playerId)
 				}
 			}
 			return undefined