feat(LSG): new resolvedPlaylistTopic

packages/live-status-gateway-api/api/asyncapi.yaml

@@ -37,6 +37,8 @@ channels:
     $ref: './topics/studio/studioTopic.yaml'
   activePlaylist:
     $ref: './topics/activePlaylist/activePlaylistTopic.yaml'
+  resolvedPlaylist:
+    $ref: './topics/resolvedPlaylist/resolvedPlaylistTopic.yaml'
   activePieces:
     $ref: './topics/activePieces/activePiecesTopic.yaml'
   segments:

packages/live-status-gateway-api/api/components/layers/outputLayer/outputLayer-example.yaml

@@ -0,0 +1,6 @@
+id: 'ol_pgm'
+name: 'PGM'
+isFlattened: false
+isPGM: true
+sourceLayerIds:
+  - 'sl_camera'

packages/live-status-gateway-api/api/components/layers/outputLayer/outputLayer.yaml

@@ -0,0 +1,27 @@
+$defs:
+  outputLayer:
+    type: object
+    title: OutputLayer
+    description: Definition of an output layer used in a segment
+    properties:
+      id:
+        type: string
+        description: Unique id of the output layer
+      name:
+        type: string
+        description: User-presentable name of the output layer
+      isFlattened:
+        type: boolean
+        description: Whether the output layer is flattened
+      isPGM:
+        type: boolean
+        description: Whether PGM treatment should be in effect
+      sourceLayerIds:
+        description: The set of sourceLayer ids that feed this output layer
+        type: array
+        items:
+          type: string
+    required: [id, name, isFlattened, isPGM, sourceLayerIds]
+    additionalProperties: false
+    examples:
+      - $ref: './outputLayer-example.yaml'

packages/live-status-gateway-api/api/components/layers/sourceLayer/sourceLayer-example.yaml

@@ -0,0 +1,6 @@
+id: 'sl_camera'
+name: 'Camera'
+abbreviation: 'CAM'
+isHidden: false
+type: 1
+rank: 0

packages/live-status-gateway-api/api/components/layers/sourceLayer/sourceLayer.yaml

@@ -0,0 +1,28 @@
+$defs:
+  sourceLayer:
+    type: object
+    title: SourceLayer
+    description: Definition of a source layer used in a segment
+    properties:
+      id:
+        type: string
+        description: Unique id of the source layer
+      name:
+        type: string
+        description: User-presentable name of the source layer
+      abbreviation:
+        type: string
+        description: Abbreviation for display
+      isHidden:
+        type: boolean
+        description: Whether the source layer is hidden in the UI
+      type:
+        type: number
+        description: Source layer content type (numeric enum)
+      rank:
+        type: number
+        description: Rank for ordering
+    required: [id, name, abbreviation, isHidden, type, rank]
+    additionalProperties: false
+    examples:
+      - $ref: './sourceLayer-example.yaml'

packages/live-status-gateway-api/api/components/part/partInvalidReason/partInvalidReason-example.yaml

@@ -0,0 +1,3 @@
+message: 'Invalid clip reference'
+severity: warning
+color: '#ff0000'

packages/live-status-gateway-api/api/components/part/partInvalidReason/partInvalidReason.yaml

@@ -0,0 +1,19 @@
+$defs:
+  partInvalidReason:
+    title: PartInvalidReason
+    description: Explanation for why a part is invalid
+    type: object
+    properties:
+      message:
+        type: string
+        description: Human-readable message explaining why the part is invalid
+      severity:
+        description: Severity hint for displaying the invalid reason
+        $ref: '../../notifications/notificationSeverity.yaml#/$defs/severity'
+      color:
+        description: Optional UI color hint
+        type: string
+    required: [message]
+    additionalProperties: false
+    examples:
+      - $ref: './partInvalidReason-example.yaml'

packages/live-status-gateway-api/api/components/part/resolvedPart/resolvedPart-example.yaml

@@ -0,0 +1,17 @@
+$ref: '../partBase/partBase-example.yaml'
+instanceId: 'partInstance_current_1'
+externalId: 'ext_part_1'
+rank: 10
+invalid: false
+floated: false
+untimed: false
+invalidReason:
+  $ref: '../partInvalidReason/partInvalidReason-example.yaml'
+state: current
+createdByAdLib: false
+publicData:
+  partType: 'intro'
+timing:
+  $ref: '../../timing/resolvedPartTiming/resolvedPartTiming-example.yaml'
+pieces:
+  - $ref: '../../piece/resolvedPiece/resolvedPiece-example.yaml'

packages/live-status-gateway-api/api/components/part/resolvedPart/resolvedPart.yaml

@@ -0,0 +1,56 @@
+$defs:
+  resolvedPartState:
+    title: ResolvedPartState
+    type: string
+    enum:
+      - current
+      - next
+
+  resolvedPart:
+    title: ResolvedPart
+    description: A part within a resolved segment
+    allOf:
+      - $ref: '../partBase/partBase.yaml#/$defs/partBase'
+      - type: object
+        title: ResolvedPart
+        description: A part within a resolved segment
+        properties:
+          instanceId:
+            type: string
+            description: Unique id of the part instance
+          externalId:
+            type: string
+            description: Id normally sourced from the ingest system
+          rank:
+            type: number
+            description: Rank for ordering
+          invalid:
+            type: boolean
+            description: Whether this part is invalid and should not be taken
+          floated:
+            type: boolean
+            description: Whether this part is floated and cannot be taken/nexted
+          untimed:
+            type: boolean
+            description: Whether this part is excluded from normal timing calculations
+          invalidReason:
+            description: Optional explanation for why the part is invalid
+            $ref: '../partInvalidReason/partInvalidReason.yaml#/$defs/partInvalidReason'
+          state:
+            description: Set only for the current or next part
+            $ref: '#/$defs/resolvedPartState'
+          createdByAdLib:
+            type: boolean
+            description: Whether this part was created by an adlib
+          publicData:
+            description: Optional arbitrary data
+          timing:
+            $ref: '../../timing/resolvedPartTiming/resolvedPartTiming.yaml#/$defs/resolvedPartTiming'
+          pieces:
+            description: Pieces in this part
+            type: array
+            items:
+              $ref: '../../piece/resolvedPiece/resolvedPiece.yaml#/$defs/resolvedPiece'
+        required: [instanceId, externalId, rank, createdByAdLib, timing, pieces, invalid, floated, untimed]
+    examples:
+      - $ref: './resolvedPart-example.yaml'

packages/live-status-gateway-api/api/components/piece/resolvedPiece/resolvedPiece-example.yaml

@@ -0,0 +1,17 @@
+id: 'piece_1'
+instanceId: 'pieceInstance_1'
+externalId: 'ext_piece_1'
+name: 'Camera 1'
+priority: 0
+sourceLayerId: 'sl_camera'
+outputLayerId: 'ol_pgm'
+createdByAdLib: false
+invalid: false
+publicData:
+  switcherSource: 1
+timing:
+  $ref: '../../timing/resolvedPieceTiming/resolvedPieceTiming-example.yaml'
+tags:
+  - 'camera'
+abSessions:
+  - $ref: '../pieceStatus/abSessionAssignment-example.yaml'

packages/live-status-gateway-api/api/components/piece/resolvedPiece/resolvedPiece.yaml

@@ -0,0 +1,52 @@
+$defs:
+  resolvedPiece:
+    type: object
+    title: ResolvedPiece
+    description: A piece within a resolved part
+    properties:
+      id:
+        type: string
+        description: Unique id of the piece
+      instanceId:
+        type: string
+        description: Unique id of the piece instance
+      externalId:
+        type: string
+        description: Id normally sourced from the ingest system
+      name:
+        type: string
+        description: User-facing name of the piece
+      priority:
+        type: number
+        description: Priority of the piece
+      sourceLayerId:
+        type: string
+        description: Id of the source layer for this piece
+      outputLayerId:
+        type: string
+        description: Id of the output layer for this piece
+      createdByAdLib:
+        type: boolean
+        description: Whether this piece was created by an adlib
+      invalid:
+        type: boolean
+        description: Whether this piece is invalid and should be ignored
+      publicData:
+        description: Optional arbitrary data
+      timing:
+        $ref: '../../timing/resolvedPieceTiming/resolvedPieceTiming.yaml#/$defs/resolvedPieceTiming'
+      tags:
+        description: Optional tags attached to this piece
+        type: array
+        items:
+          type: string
+      abSessions:
+        description: Optional AB playback session assignments for this piece
+        type: array
+        items:
+          $ref: '../pieceStatus/abSessionAssignment.yaml'
+    required:
+      [id, instanceId, externalId, name, priority, sourceLayerId, outputLayerId, createdByAdLib, invalid, timing]
+    additionalProperties: false
+    examples:
+      - $ref: './resolvedPiece-example.yaml'

packages/live-status-gateway-api/api/components/playlist/playlistStatus/playlistStatus.yaml

@@ -21,6 +21,5 @@ $defs:
           - rehearsal
           - activated
     required: [id, externalId, name, activationStatus]
-    additionalProperties: false
     examples:
       - $ref: './playlistStatus-example.yaml'

packages/live-status-gateway-api/api/components/resolvedPlaylist/messages/resolvedPlaylistMessage.yaml

@@ -0,0 +1,11 @@
+components:
+  messages:
+    resolvedPlaylistMessage:
+      name: resolvedPlaylist
+      messageId: resolvedPlaylistUpdate
+      description: Resolved Playlist status
+      payload:
+        $ref: '../resolvedPlaylistEvent/resolvedPlaylistEvent.yaml#/$defs/resolvedPlaylistEvent'
+      examples:
+        - payload:
+            $ref: '../resolvedPlaylistEvent/resolvedPlaylistEvent-example.yaml'

packages/live-status-gateway-api/api/components/resolvedPlaylist/resolvedPlaylistEvent/resolvedPlaylistEvent-example.yaml

@@ -0,0 +1,18 @@
+$ref: '../../playlist/playlistStatus/playlistStatus-example.yaml'
+event: resolvedPlaylist
+currentPartInstanceId: 'partInstance_current_1'
+nextPartInstanceId: 'partInstance_next_1'
+playoutState:
+  mode: 'AUTO'
+publicData:
+  category: 'Evening News'
+timing:
+  $ref: '../../timing/resolvedPlaylistTiming/resolvedPlaylistTiming-example.yaml'
+tTimers:
+  - $ref: '../../tTimers/tTimerStatus-countdownRunning-example.yaml'
+  - $ref: '../../tTimers/tTimerStatus-freeRunRunning-example.yaml'
+  - $ref: '../../tTimers/tTimerStatus-unconfigured-example.yaml'
+quickLoop:
+  $ref: '../../quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop-example.yaml'
+rundowns:
+  - $ref: '../../rundown/resolvedRundown/resolvedRundown-example.yaml'

packages/live-status-gateway-api/api/components/resolvedPlaylist/resolvedPlaylistEvent/resolvedPlaylistEvent.yaml

@@ -0,0 +1,51 @@
+title: Resolved Playlist
+description: Resolved Playlist schema for websocket subscriptions
+$defs:
+  resolvedPlaylistEvent:
+    title: ResolvedPlaylistEvent
+    description: Resolved playlist details, including the base playlist status.
+    allOf:
+      - $ref: '../../playlist/playlistStatus/playlistStatus.yaml#/$defs/playlistStatus'
+      - type: object
+        title: ResolvedPlaylistEvent
+        description: Resolved playlist details, including rundown/segment/part/piece structure.
+        properties:
+          event:
+            type: string
+            const: resolvedPlaylist
+          currentPartInstanceId:
+            description: Instance id of the current part, if any
+            oneOf:
+              - type: string
+              - type: 'null'
+          nextPartInstanceId:
+            description: Instance id of the next part, if any
+            oneOf:
+              - type: string
+              - type: 'null'
+          playoutState:
+            description: Blueprint-defined playout state, used to expose arbitrary information about playout
+          publicData:
+            description: Optional arbitrary data
+          timing:
+            $ref: '../../timing/resolvedPlaylistTiming/resolvedPlaylistTiming.yaml#/$defs/resolvedPlaylistTiming'
+          tTimers:
+            description: Status of the 3 T-timers in the playlist
+            type: array
+            items:
+              $ref: '../../tTimers/tTimerStatus.yaml#/$defs/tTimerStatus'
+            minItems: 3
+            maxItems: 3
+          quickLoop:
+            description: Information about the current quickLoop, if any
+            oneOf:
+              - type: 'null'
+              - $ref: '../../quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop.yaml#/$defs/activePlaylistQuickLoop'
+          rundowns:
+            description: The rundowns in the playlist, in rank order
+            type: array
+            items:
+              $ref: '../../rundown/resolvedRundown/resolvedRundown.yaml#/$defs/resolvedRundown'
+        required: [event, currentPartInstanceId, nextPartInstanceId, timing, tTimers, rundowns]
+    examples:
+      - $ref: './resolvedPlaylistEvent-example.yaml'

packages/live-status-gateway-api/api/components/rundown/resolvedRundown/resolvedRundown-example.yaml

@@ -0,0 +1,9 @@
+id: 'rd_1'
+externalId: 'ext_rd_1'
+name: 'Rundown 1'
+rank: 10
+description: ''
+publicData:
+  ingestSource: 'NRK'
+segments:
+  - $ref: '../../segment/resolvedSegment/resolvedSegment-example.yaml'

packages/live-status-gateway-api/api/components/rundown/resolvedRundown/resolvedRundown.yaml

@@ -0,0 +1,32 @@
+$defs:
+  resolvedRundown:
+    type: object
+    title: ResolvedRundown
+    description: A rundown within a resolved playlist
+    properties:
+      id:
+        type: string
+        description: Unique id of the rundown
+      externalId:
+        type: string
+        description: Id normally sourced from the ingest system
+      name:
+        type: string
+        description: User-presentable name of the rundown
+      rank:
+        type: number
+        description: Rank for ordering
+      description:
+        type: string
+        description: Optional description
+      publicData:
+        description: Optional arbitrary data
+      segments:
+        description: Segments in this rundown
+        type: array
+        items:
+          $ref: '../../segment/resolvedSegment/resolvedSegment.yaml#/$defs/resolvedSegment'
+    required: [id, externalId, name, rank, segments]
+    additionalProperties: false
+    examples:
+      - $ref: './resolvedRundown-example.yaml'

packages/live-status-gateway-api/api/components/segment/resolvedSegment/resolvedSegment-example.yaml

@@ -0,0 +1,16 @@
+$ref: '../segmentBase/segmentBase-example.yaml'
+externalId: 'ext_seg_1'
+identifier: 'A'
+name: 'Headlines'
+rank: 1
+isHidden: false
+sourceLayers:
+  - $ref: '../../layers/sourceLayer/sourceLayer-example.yaml'
+outputLayers:
+  - $ref: '../../layers/outputLayer/outputLayer-example.yaml'
+publicData:
+  slug: 'HEAD'
+timing:
+  $ref: '../../timing/resolvedSegmentTiming/resolvedSegmentTiming-example.yaml'
+parts:
+  - $ref: '../../part/resolvedPart/resolvedPart-example.yaml'