chore: method doc

nrkno · Oct 11, 2023 · 7a7724f · 7a7724f
1 parent 2135dc0
commit 7a7724f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/packages/job-worker/src/playout/model/PlayoutPartInstanceModel.ts b/packages/job-worker/src/playout/model/PlayoutPartInstanceModel.ts
@@ -56,8 +56,13 @@ export interface PlayoutPartInstanceModel {
 		infiniteInstanceId: PieceInstanceInfiniteId
 	): PlayoutPieceInstanceModel
 
-	/** @deprecated HACK */
-	insertPlannedPiece(doc: Omit<PieceInstancePiece, 'startPartId'>): PlayoutPieceInstanceModel
+	/**
+	 * Insert a Piece as if it were originally planned at the time of ingest
+	 * This is a weird operation to have for playout, but it is a needed part of the SyncIngestChanges flow
+	 * @param piece Piece to insert into this PartInstance
+	 * @returns The inserted PlayoutPieceInstanceModel
+	 */
+	insertPlannedPiece(piece: Omit<PieceInstancePiece, 'startPartId'>): PlayoutPieceInstanceModel
 
 	insertVirtualPiece(
 		start: number,

diff --git a/packages/job-worker/src/playout/model/implementation/PlayoutPartInstanceModelImpl.ts b/packages/job-worker/src/playout/model/implementation/PlayoutPartInstanceModelImpl.ts
@@ -243,9 +243,6 @@ export class PlayoutPartInstanceModelImpl implements PlayoutPartInstanceModel {
 		return pieceInstanceModel
 	}
 
-	/** @deprecated HACK
-	 *
-	 */
 	insertPlannedPiece(piece: Omit<PieceInstancePiece, 'startPartId'>): PlayoutPieceInstanceModel {
 		const pieceInstanceId = getPieceInstanceIdForPiece(this.PartInstance._id, piece._id)
 		if (this.PieceInstancesImpl.has(pieceInstanceId))