feat: add ignoreQuickLoop as an optional attr in the openAPI

bbc · Jan 9, 2025 · cf72b49 · cf72b49
1 parent b87cd9f
commit cf72b49
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/meteor/server/api/rest/v1/playlists.ts b/meteor/server/api/rest/v1/playlists.ts
@@ -275,7 +275,8 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 		connection: Meteor.Connection,
 		event: string,
 		rundownPlaylistId: RundownPlaylistId,
-		delta: number
+		delta: number,
+		ignoreQuickLoop?: boolean
 	): Promise<ClientAPI.ClientResponse<PartId | null>> {
 		return ServerClientAPI.runUserActionInLogForPlaylistOnWorker(
 			this.context.getMethodContext(connection),
@@ -291,6 +292,7 @@ class PlaylistsServerAPI implements PlaylistsRestAPI {
 				playlistId: rundownPlaylistId,
 				partDelta: delta,
 				segmentDelta: 0,
+				ignoreQuickLoop,
 			}
 		)
 	}

diff --git a/meteor/server/lib/rest/v1/playlists.ts b/meteor/server/lib/rest/v1/playlists.ts
@@ -109,12 +109,14 @@ export interface PlaylistsRestAPI {
 	 * @param event User event string
 	 * @param rundownPlaylistId Playlist to target.
 	 * @param delta Amount to move next point by (+/-)
+	 * @param ignoreQuickLoop When moving the next part it should ignore any of the boundaries set by the QuickLoop feature
 	 */
 	moveNextPart(
 		connection: Meteor.Connection,
 		event: string,
 		rundownPlaylistId: RundownPlaylistId,
-		delta: number
+		delta: number,
+		ignoreQuickLoop?: boolean
 	): Promise<ClientAPI.ClientResponse<PartId | null>>
 	/**
 	 * Moves the next Segment point by `delta` places. Negative values are allowed to move "backwards" in the script.

diff --git a/packages/openapi/api/definitions/playlists.yaml b/packages/openapi/api/definitions/playlists.yaml
@@ -278,6 +278,9 @@ resources:
                 delta:
                   type: number
                   description: Amount to move next Segment point by (+/-). If delta results in an index that is greater than the number of Segments available, no action will be taken.
+                ignoreQuickLoop:
+                  type: boolean
+                  description: When true, the operation will ignore any boundaries set by the QuickLoop feature when moving to the next part
               required:
                 - delta
       responses: