@bbc/sofie-live-status-gateway-api 1.53.0-in-development

package/api/components/notifications/target/rundownPlaylist/notificationTargetRundownPlaylist.yaml

@@ -0,0 +1,16 @@
+$defs:
+  NotificationTargetRundownPlaylist:
+    type: object
+    title: NotificationTargetRundownPlaylist
+    required: [type, studioId, playlistId]
+    properties:
+      type:
+        $ref: '../notificationTargetType.yaml#/$defs/NotificationTargetType'
+        const: playlist
+      studioId:
+        type: string
+      playlistId:
+        type: string
+    additionalProperties: false
+    examples:
+      - $ref: './notificationTargetRundownPlaylist-example.yaml'

package/api/components/notifications/target/unknown/notificationTargetUnknown-example.yaml

@@ -0,0 +1 @@
+type: unknown

package/api/components/notifications/target/unknown/notificationTargetUnknown.yaml

@@ -0,0 +1,12 @@
+$defs:
+  NotificationTargetUnknown:
+    type: object
+    title: NotificationTargetUnknown
+    required: [type]
+    properties:
+      type:
+        $ref: '../notificationTargetType.yaml#/$defs/NotificationTargetType'
+        const: unknown
+    additionalProperties: false
+    examples:
+      - $ref: './notificationTargetUnknown-example.yaml'

package/api/components/packages/messages/packagesMessage.yaml

@@ -0,0 +1,8 @@
+components:
+  messages:
+    packagesMessage:
+      name: packages
+      messageId: packages
+      description: Status of Packages expected by Pieces
+      payload:
+        $ref: '../packagesEvent/packagesEvent.yaml'

package/api/components/packages/packageInfoStatus/packageInfoStatus-example.yaml

@@ -0,0 +1,8 @@
+packageName: 'MV000123.mxf'
+status: ok
+rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
+partId: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+segmentId: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+pieceOrAdLibId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+thumbnailUrl: 'https://package-manager.local/package/MV000123.mov_thumbnail.jpg'
+previewUrl: 'https://package-manager.local/package/MV000123.mov_preview'

package/api/components/packages/packageInfoStatus/packageInfoStatus.yaml

@@ -0,0 +1,32 @@
+$defs:
+  packageInfoStatus:
+    title: PackageInfoStatus
+    type: object
+    properties:
+      packageName:
+        description: Name of the package
+        type: string
+      status:
+        $ref: '../packageStatus/packageStatus.yaml#/$defs/packageStatus'
+      rundownId:
+        description: Id of the Rundown that a Piece (or AdLib) expecting this package belongs to
+        type: string
+      partId:
+        description: Id of the Part that a Piece (or AdLib) expecting this package belongs to. It could be an Id of a Part from the Active Playlist topic, or a Part not exposed otherwise by the LSG.
+        type: string
+      segmentId:
+        description: Id of the Segment that a Piece (or AdLib) expecting this package belongs to
+        type: string
+      pieceOrAdLibId:
+        description: Id of the Piece or AdLib that expects this package. It could be an Id of a Piece from the Active Pieces and Active Playlist topics, or an Id of an AdLib from the AdLibs topic. It could also be an Id of a Piece not exposed otherwise by the LSG, but still relevant, e.g. to summarize the status of packages within a specific Part/Segment.
+        type: string
+      thumbnailUrl:
+        description: URL where the thumbnail can be accessed
+        type: string
+      previewUrl:
+        description: URL where the preview can be accessed
+        type: string
+    required: [status, rundownId, pieceOrAdLibId]
+    additionalProperties: false
+    examples:
+      - $ref: './packageInfoStatus-example.yaml'

package/api/components/packages/packageStatus/packageStatus.yaml

@@ -0,0 +1,23 @@
+$defs:
+  packageStatus:
+    title: PackageStatus
+    type: string
+    description: |
+      Status:
+      * `unknown` - status not determined (yet)
+      * `ok` - no faults, can be played
+      * `source_broken` - the source is present, but should not be played due to a technical malfunction (file is broken, camera robotics failed, REMOTE input is just bars, etc.)
+      * `source_has_issues` - technically it can be played, but some issues with it were detected
+      * `source_missing` - the source (file, live input) is missing and cannot be played
+      * `source_not_ready` - can't be played for a non-technical reason (e.g. a placeholder clip with no content)
+      * `source_not_set` - missing a file path
+      * `source_unknown_state` - reported, but unrecognized state
+    enum:
+      - unknown
+      - ok
+      - source_broken
+      - source_has_issues
+      - source_missing
+      - source_not_ready
+      - source_not_set
+      - source_unknown_state

package/api/components/packages/packagesEvent/packagesEvent-example.yaml

@@ -0,0 +1,4 @@
+event: packages
+rundownPlaylistId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
+packages:
+  - $ref: '../packageInfoStatus/packageInfoStatus-example.yaml'

package/api/components/packages/packagesEvent/packagesEvent.yaml

@@ -0,0 +1,20 @@
+title: PackagesEvent
+type: object
+properties:
+  event:
+    type: string
+    const: packages
+  rundownPlaylistId:
+    description: Unique id of the rundown playlist, or null if no playlist is active
+    oneOf:
+      - type: string
+      - type: 'null'
+  packages:
+    description: The Package statuses for this playlist
+    type: array
+    items:
+      $ref: '../packageInfoStatus/packageInfoStatus.yaml#/$defs/packageInfoStatus'
+required: [event, rundownPlaylistId, packages]
+additionalProperties: false
+examples:
+  - $ref: './packagesEvent-example.yaml'

package/api/components/part/currentPart/currentPartStatus-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../partStatus/partStatus-example.yaml'
+timing:
+  $ref: '../../timing/currentPartTiming/currentPartTiming-example.yaml'

package/api/components/part/currentPart/currentPartStatus.yaml

@@ -0,0 +1,13 @@
+$defs:
+  currentPartStatus:
+    title: CurrentPartStatus
+    allOf:
+      - $ref: '../partStatus/partStatus.yaml#/$defs/partStatus'
+      - type: object
+        title: CurrentPartStatus
+        properties:
+          timing:
+            $ref: '../../timing/currentPartTiming/currentPartTiming.yaml#/$defs/currentPartTiming'
+        required: [timing]
+    examples:
+      - $ref: './currentPartStatus-example.yaml'

package/api/components/part/currentSegmentPart/currentSegmentPart-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../partBase/partBase-example.yaml'
+timing:
+  expectedDurationMs: 15000

package/api/components/part/currentSegmentPart/currentSegmentPart.yaml

@@ -0,0 +1,14 @@
+$defs:
+  currentSegmentPart:
+    title: CurrentSegmentPart
+    type: object
+    allOf:
+      - $ref: '../partBase/partBase.yaml#/$defs/partBase'
+      - type: object
+        title: CurrentSegmentPart
+        properties:
+          timing:
+            $ref: '../../timing/currentSegmentPartTiming/currentSegmentPartTiming.yaml#/$defs/currentSegmentPartTiming'
+    required: [id, name, timing]
+    examples:
+      - $ref: './currentSegmentPart-example.yaml'

package/api/components/part/partBase/partBase-example.yaml

@@ -0,0 +1,3 @@
+id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+name: 'Intro'
+autoNext: false

package/api/components/part/partBase/partBase.yaml

@@ -0,0 +1,18 @@
+$defs:
+  partBase:
+    type: object
+    title: PartBase
+    properties:
+      id:
+        description: Unique id of the part
+        type: string
+      name:
+        description: User-presentable name of the part
+        type: string
+      autoNext:
+        description: If this part will progress to the next automatically
+        type: boolean
+        default: false
+    required: [id, name]
+    examples:
+      - $ref: './partBase-example.yaml'

package/api/components/part/partStatus/partStatus-example.yaml

@@ -0,0 +1,6 @@
+$ref: '../partBase/partBase-example.yaml'
+segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+pieces:
+  - $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus/examples/0'
+publicData:
+  partType: 'intro'

package/api/components/part/partStatus/partStatus.yaml

@@ -0,0 +1,22 @@
+$defs:
+  partStatus:
+    type: object
+    title: PartStatus
+    allOf:
+      - $ref: '../partBase/partBase.yaml#/$defs/partBase'
+      - type: object
+        title: PartStatus
+        properties:
+          segmentId:
+            description: Unique id of the segment this part belongs to
+            type: string
+          pieces:
+            description: All pieces in this part
+            type: array
+            items:
+              $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus'
+          publicData:
+            description: Optional arbitrary data
+        required: [id, name, segmentId, pieces]
+    examples:
+      - $ref: './partStatus-example.yaml'

package/api/components/piece/activePiecesEvent/activePiecesEvent-example.yaml

@@ -0,0 +1,4 @@
+event: activePieces
+rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+activePieces:
+  - $ref: '../pieceStatus/pieceStatus-example.yaml'

package/api/components/piece/activePiecesEvent/activePiecesEvent.yaml

@@ -0,0 +1,22 @@
+$defs:
+  activePiecesEvent:
+    type: object
+    title: ActivePiecesEvent
+    properties:
+      event:
+        type: string
+        const: activePieces
+      rundownPlaylistId:
+        description: Unique id of the rundown playlist, or null if no playlist is active
+        oneOf:
+          - type: string
+          - type: 'null'
+      activePieces:
+        description: Pieces that are currently active (on air)
+        type: array
+        items:
+          $ref: '../pieceStatus/pieceStatus.yaml#/$defs/pieceStatus'
+    required: [event, rundownPlaylistId, activePieces]
+    additionalProperties: false
+    examples:
+      - $ref: './activePiecesEvent-example.yaml'

package/api/components/piece/messages/activePiecesMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    activePiecesMessage:
+      messageId: activePieces
+      title: Active Pieces Event Message
+      payload:
+        $ref: '../activePiecesEvent/activePiecesEvent.yaml#/$defs/activePiecesEvent'
+      examples:
+        - payload:
+            $ref: '../activePiecesEvent/activePiecesEvent-example.yaml'

package/api/components/piece/pieceStatus/pieceStatus-example.yaml

@@ -0,0 +1,7 @@
+id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+name: 'Camera 1'
+sourceLayer: 'Camera'
+outputLayer: 'PGM'
+tags: ['camera']
+publicData:
+  switcherSource: 1

package/api/components/piece/pieceStatus/pieceStatus.yaml

@@ -0,0 +1,28 @@
+$defs:
+  pieceStatus:
+    type: object
+    title: PieceStatus
+    properties:
+      id:
+        description: Unique id of the Piece
+        type: string
+      name:
+        description: User-facing name of the Piece
+        type: string
+      sourceLayer:
+        description: The source layer name for this Piece
+        type: string
+      outputLayer:
+        description: The output layer name for this Piece
+        type: string
+      tags:
+        description: Tags attached to this Piece
+        type: array
+        items:
+          type: string
+      publicData:
+        description: Optional arbitrary data
+    required: [id, name, sourceLayer, outputLayer]
+    additionalProperties: false
+    examples:
+      - $ref: './pieceStatus-example.yaml'

package/api/components/playlist/activePlaylistEvent/activePlaylistEvent-example.yaml

@@ -0,0 +1,17 @@
+event: activePlaylist
+id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+externalId: '1ZIYVYL1aEkNEJbeGsmRXr5s8wtkyxfPRjNSTxZfcoEI'
+name: 'Playlist 0'
+rundownIds: ['y9HauyWkcxQS3XaAOsW40BRLLsI_']
+currentPart:
+  $ref: '../../part/currentPart/currentPartStatus-example.yaml'
+currentSegment:
+  $ref: '../../segment/currentSegment/currentSegment-example.yaml'
+nextPart:
+  $ref: '../../part/partStatus/partStatus-example.yaml'
+publicData:
+  category: 'Evening News'
+timing:
+  $ref: '../../timing/activePlaylistTiming/activePlaylistTiming-example.yaml'
+quickLoop:
+  $ref: '../../quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop-example.yaml'

package/api/components/playlist/activePlaylistEvent/activePlaylistEvent.yaml

@@ -0,0 +1,50 @@
+title: Active Playlist
+description: Active Playlist schema for websocket subscriptions
+$defs:
+  activePlaylistEvent:
+    type: object
+    title: ActivePlaylistEvent
+    properties:
+      event:
+        type: string
+        const: activePlaylist
+      id:
+        description: Unique id of the active playlist
+        oneOf:
+          - type: string
+          - type: 'null'
+      externalId:
+        description: Id normally sourced from the ingest system
+        oneOf:
+          - type: string
+          - type: 'null'
+      name:
+        description: User-presentable name for the active playlist
+        type: string
+      rundownIds:
+        description: The set of rundownIds in the active playlist, in order
+        type: array
+        items:
+          type: string
+      currentPart:
+        oneOf:
+          - $ref: '../../part/currentPart/currentPartStatus.yaml#/$defs/currentPartStatus'
+          - type: 'null'
+      currentSegment:
+        oneOf:
+          - $ref: '../../segment/currentSegment/currentSegment.yaml#/$defs/currentSegment'
+          - type: 'null'
+      nextPart:
+        oneOf:
+          - $ref: '../../part/partStatus/partStatus.yaml#/$defs/partStatus'
+          - type: 'null'
+      publicData:
+        description: Optional arbitrary data
+      timing:
+        $ref: '../../timing/activePlaylistTiming/activePlaylistTiming.yaml#/$defs/activePlaylistTiming'
+      quickLoop:
+        $ref: '../../quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop.yaml#/$defs/activePlaylistQuickLoop'
+    required: [event, id, externalId, name, rundownIds, currentPart, currentSegment, nextPart, timing]
+    additionalProperties: false
+    examples:
+      - $ref: './activePlaylistEvent-example.yaml'

package/api/components/playlist/messages/activePlaylistMessage.yaml

@@ -0,0 +1,11 @@
+components:
+  messages:
+    activePlaylistMessage:
+      name: activePlaylist
+      messageId: activePlaylistUpdate
+      description: Active Playlist status
+      payload:
+        $ref: '../activePlaylistEvent/activePlaylistEvent.yaml#/$defs/activePlaylistEvent'
+      examples:
+        - payload:
+            $ref: '../activePlaylistEvent/activePlaylistEvent-example.yaml'

package/api/components/playlist/playlistStatus/playlistStatus-example.yaml

@@ -0,0 +1,4 @@
+id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+externalId: '1ZIYVYL1aEkNEJbeGsmRXr5s8wtkyxfPRjNSTxZfcoEI'
+name: 'Playlist 0'
+activationStatus: rehearsal

package/api/components/playlist/playlistStatus/playlistStatus.yaml

@@ -0,0 +1,26 @@
+$defs:
+  playlistStatus:
+    title: PlaylistStatus
+    type: object
+    properties:
+      id:
+        description: Unique id of the playlist
+        type: string
+      externalId:
+        description: Id normally sourced from the ingest system
+        type: string
+      name:
+        description: The user defined playlist name
+        type: string
+      activationStatus:
+        description: Whether this playlist is currently active or in rehearsal
+        type: string
+        title: PlaylistActivationStatus
+        enum:
+          - deactivated
+          - rehearsal
+          - activated
+    required: [id, externalId, name, activationStatus]
+    additionalProperties: false
+    examples:
+      - $ref: './playlistStatus-example.yaml'

package/api/components/quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop-example.yaml

@@ -0,0 +1,6 @@
+locked: false
+running: true
+start:
+  $ref: '../quickLoopMarker/quickLoopMarker-example.yaml'
+end:
+  $ref: '../quickLoopMarker/quickLoopMarker-example.yaml'

package/api/components/quickLoop/activePlaylistQuickLoop/activePlaylistQuickLoop.yaml

@@ -0,0 +1,19 @@
+$defs:
+  activePlaylistQuickLoop:
+    description: Information about the current quickLoop, if any
+    type: object
+    title: ActivePlaylistQuickLoop
+    properties:
+      locked:
+        description: Whether the user is allowed to make alterations to the Start/End markers
+        type: boolean
+      running:
+        description: Whether the loop has two valid markers and is currently running
+        type: boolean
+      start:
+        $ref: '../quickLoopMarker/quickLoopMarker.yaml#/$defs/quickLoopMarker'
+      end:
+        $ref: '../quickLoopMarker/quickLoopMarker.yaml#/$defs/quickLoopMarker'
+    required: [locked, running]
+    examples:
+      - $ref: './activePlaylistQuickLoop-example.yaml'

package/api/components/quickLoop/quickLoopMarker/quickLoopMarker-example.yaml

@@ -0,0 +1,2 @@
+markerType: rundown
+rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'

package/api/components/quickLoop/quickLoopMarker/quickLoopMarker.yaml

@@ -0,0 +1,20 @@
+$defs:
+  quickLoopMarker:
+    type: object
+    title: QuickLoopMarker
+    description: Represents a positional marker used to define the start or end of a Quick Loop by referencing a rundown, segment, or part.
+    properties:
+      markerType:
+        $ref: '../quickLoopMarkerType.yaml#/$defs/quickLoopMarkerType'
+      rundownId:
+        description: The rundown that this marker references. This will be set for rundown, segment and part markers
+        type: string
+      segmentId:
+        description: The segment that this marker references. This will be set for segment and part markers
+        type: string
+      partId:
+        description: The part that this marker references. This will be set for only part markers
+        type: string
+    required: [markerType]
+    examples:
+      - $ref: './quickLoopMarker-example.yaml'

package/api/components/quickLoop/quickLoopMarkerType.yaml

@@ -0,0 +1,10 @@
+$defs:
+  quickLoopMarkerType:
+    type: string
+    title: QuickLoopMarkerType
+    description: The type of entity the marker is locked to
+    enum:
+      - playlist
+      - rundown
+      - segment
+      - part

package/api/components/segment/currentSegment/currentSegment-example.yaml

@@ -0,0 +1,5 @@
+$ref: '../segmentBase/segmentBase-example.yaml'
+timing:
+  $ref: '../../timing/currentSegmentTiming/currentSegmentTiming-example.yaml'
+parts:
+  - $ref: '../../part/currentSegmentPart/currentSegmentPart-example.yaml'

package/api/components/segment/currentSegment/currentSegment.yaml

@@ -0,0 +1,19 @@
+$defs:
+  currentSegment:
+    type: object
+    title: CurrentSegment
+    allOf:
+      - $ref: '../segmentBase/segmentBase.yaml#/$defs/segmentBase'
+      - title: CurrentSegment
+        type: object
+        properties:
+          timing:
+            $ref: '../../timing/currentSegmentTiming/currentSegmentTiming.yaml#/$defs/currentSegmentTiming'
+          parts:
+            type: array
+            items:
+              $ref: '../../part/currentSegmentPart/currentSegmentPart.yaml#/$defs/currentSegmentPart'
+        required: [timing, parts]
+    required: [id, timing, parts]
+    examples:
+      - $ref: './currentSegment-example.yaml'

package/api/components/segment/messages/segmentsMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    segmentsMessage:
+      messageId: segments
+      title: Segments Event Message
+      payload:
+        $ref: '../segmentsEvent/segmentsEvent.yaml#/$defs/segmentsEvent'
+      examples:
+        - payload:
+            $ref: '../segmentsEvent/segmentsEvent-example.yaml'

package/api/components/segment/segment/segment-example.yaml

@@ -0,0 +1,8 @@
+$ref: '../segmentBase/segmentBase-example.yaml'
+identifier: 'Segment 0 identifier'
+rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
+name: 'Segment 0'
+timing:
+  $ref: '../../timing/segmentTiming/segmentTiming-example.yaml'
+publicData:
+  containsLiveSource: true

package/api/components/segment/segment/segment.yaml

@@ -0,0 +1,26 @@
+$defs:
+  segment:
+    type: object
+    title: Segment
+    allOf:
+      - $ref: '../segmentBase/segmentBase.yaml#/$defs/segmentBase'
+      - type: object
+        title: Segment
+        properties:
+          identifier:
+            description: User-facing identifier that can be used to identify the contents of a segment in the Rundown source system
+            type: string
+          rundownId:
+            description: Unique id of the rundown this segment belongs to
+            type: string
+          name:
+            description: Name of the segment
+            type: string
+          timing:
+            $ref: '../../timing/segmentTiming/segmentTiming.yaml#/$defs/segmentTiming'
+          publicData:
+            description: Optional arbitrary data
+        required: [rundownId, name, timing]
+    required: [id, rundownId, name, timing]
+    examples:
+      - $ref: './segment-example.yaml'

package/api/components/segment/segmentBase/segmentBase-example.yaml

@@ -0,0 +1 @@
+id: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'

package/api/components/segment/segmentBase/segmentBase.yaml

@@ -0,0 +1,11 @@
+$defs:
+  segmentBase:
+    title: SegmentBase
+    type: object
+    properties:
+      id:
+        type: string
+        description: Unique id of the segment
+    required: [id]
+    examples:
+      - $ref: './segmentBase-example.yaml'

package/api/components/segment/segmentsEvent/segmentsEvent-example.yaml

@@ -0,0 +1,4 @@
+event: segments
+rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+segments:
+  - $ref: '../segment/segment-example.yaml'

package/api/components/segment/segmentsEvent/segmentsEvent.yaml

@@ -0,0 +1,23 @@
+title: Segments
+description: Segments schema for websocket subscriptions
+$defs:
+  segmentsEvent:
+    type: object
+    title: SegmentsEvent
+    properties:
+      event:
+        type: string
+        const: segments
+      rundownPlaylistId:
+        description: Unique id of the rundown playlist, or null if no playlist is active
+        oneOf:
+          - type: string
+          - type: 'null'
+      segments:
+        description: The segments that are in the currently active rundown playlist, in order
+        type: array
+        items:
+          $ref: '../segment/segment.yaml#/$defs/segment'
+    required: [event, rundownPlaylistId, segments]
+    examples:
+      - $ref: './segmentsEvent-example.yaml'

package/api/components/studio/messages/studioUpdate.yaml

@@ -0,0 +1,11 @@
+components:
+  messages:
+    studioUpdate:
+      name: studio
+      messageId: studioUpdate
+      description: Studio status
+      payload:
+        $ref: '../studioEvent/studioEvent.yaml#/$defs/studioEvent'
+      examples:
+        - payload:
+            $ref: '../studioEvent/studioEvent-example.yaml'

package/api/components/studio/studioEvent/studioEvent-example.yaml

@@ -0,0 +1,2 @@
+event: studio
+$ref: '../studioStatus/studioStatus-example.yaml'

package/api/components/studio/studioEvent/studioEvent.yaml

@@ -0,0 +1,16 @@
+$defs:
+  studioEvent:
+    title: StudioEvent
+    type: object
+    allOf:
+      - title: StudioEvent
+        type: object
+        properties:
+          event:
+            type: string
+            const: studio
+        required: [event]
+      - $ref: '../studioStatus/studioStatus.yaml#/$defs/studioStatus'
+    required: [event, id, name, playlists]
+    examples:
+      - $ref: './studioEvent-example.yaml'