Merge pull request Sofie-Automation#1298 from bbc/upstream/chore-add-lsg-playlist-timing

Author: jstarpl

packages/live-status-gateway/api/schemas/activePlaylist.yaml

@@ -29,7 +29,32 @@ $defs:
         $ref: '#/$defs/part'
       publicData:
         description: Optional arbitrary data
-    required: [event, id, name, rundownIds, currentPart, currentSegment, nextPart]
+      timing:
+        description: Timing information about the active playlist
+        type: object
+        properties:
+          timingMode:
+            description: 'Timing mode for the playlist.'
+            type: string
+            enum:
+              - none
+              - forward-time
+              - back-time
+          startedPlayback:
+            description: Unix timestamp of when the playlist started (milliseconds)
+            type: number
+          expectedStart:
+            description: Unix timestamp of when the playlist is expected to start (milliseconds). Required when the timingMode is set to forward-time.
+            type: number
+          expectedDurationMs:
+            description: Duration of the playlist in ms
+            type: number
+          expectedEnd:
+            description: Unix timestamp of when the playlist is expected to end (milliseconds) Required when the timingMode is set to back-time.
+            type: number
+        required: [timingMode]
+        additionalProperties: false
+    required: [event, id, name, rundownIds, currentPart, currentSegment, nextPart, timing]
     additionalProperties: false
     examples:
       - event: activePlaylist
@@ -44,6 +69,10 @@ $defs:
           $ref: '#/$defs/part/examples/0'
         publicData:
           category: 'Evening News'
+        timing:
+          timingMode: 'forward-time'
+          expectedStart: 1728895750727
+          expectedDurationMs: 180000
   partBase:
     type: object
     properties:

packages/live-status-gateway/src/topics/__tests__/activePlaylist.spec.ts

@@ -9,6 +9,7 @@ import { literal } from '@sofie-automation/corelib/dist/lib'
 import { DBPartInstance } from '@sofie-automation/corelib/dist/dataModel/PartInstance'
 import { PartsHandler } from '../../collections/partsHandler'
 import { DBPart } from '@sofie-automation/corelib/dist/dataModel/Part'
+import { PlaylistTimingType } from '@sofie-automation/blueprints-integration'
 
 function makeEmptyTestPartInstances(): SelectedPartInstances {
 	return {
@@ -46,6 +47,9 @@ describe('ActivePlaylistTopic', () => {
 			currentSegment: null,
 			rundownIds: unprotectStringArray(playlist.rundownIdsInOrder),
 			publicData: undefined,
+			timing: {
+				timingMode: PlaylistTimingType.None,
+			},
 		}
 
 		// eslint-disable-next-line @typescript-eslint/unbound-method
@@ -125,6 +129,9 @@ describe('ActivePlaylistTopic', () => {
 			},
 			rundownIds: unprotectStringArray(playlist.rundownIdsInOrder),
 			publicData: { a: 'b' },
+			timing: {
+				timingMode: PlaylistTimingType.None,
+			},
 		}
 
 		// eslint-disable-next-line @typescript-eslint/unbound-method

packages/live-status-gateway/src/topics/activePlaylistTopic.ts

@@ -15,6 +15,7 @@ import _ = require('underscore')
 import { PartTiming, calculateCurrentPartTiming } from './helpers/partTiming'
 import { SelectedPieceInstances, PieceInstancesHandler, PieceInstanceMin } from '../collections/pieceInstancesHandler'
 import { PieceStatus, toPieceStatus } from './helpers/pieceStatus'
+import { PlaylistTimingType } from '@sofie-automation/blueprints-integration'
 
 const THROTTLE_PERIOD_MS = 100
 
@@ -45,6 +46,13 @@ export interface ActivePlaylistStatus {
 	currentSegment: CurrentSegmentStatus | null
 	nextPart: PartStatus | null
 	publicData: unknown
+	timing: {
+		timingMode: PlaylistTimingType
+		startedPlayback?: number
+		expectedStart?: number
+		expectedDurationMs?: number
+		expectedEnd?: number
+	}
 }
 
 export class ActivePlaylistTopic
@@ -141,6 +149,19 @@ export class ActivePlaylistTopic
 						  })
 						: null,
 					publicData: this._activePlaylist.publicData,
+					timing: {
+						timingMode: this._activePlaylist.timing.type,
+						startedPlayback: this._activePlaylist.startedPlayback,
+						expectedDurationMs: this._activePlaylist.timing.expectedDuration,
+						expectedStart:
+							this._activePlaylist.timing.type !== PlaylistTimingType.None
+								? this._activePlaylist.timing.expectedStart
+								: undefined,
+						expectedEnd:
+							this._activePlaylist.timing.type !== PlaylistTimingType.None
+								? this._activePlaylist.timing.expectedEnd
+								: undefined,
+					},
 			  })
 			: literal<ActivePlaylistStatus>({
 					event: 'activePlaylist',
@@ -151,6 +172,9 @@ export class ActivePlaylistTopic
 					currentSegment: null,
 					nextPart: null,
 					publicData: undefined,
+					timing: {
+						timingMode: PlaylistTimingType.None,
+					},
 			  })
 
 		this.sendMessage(subscribers, message)