viz reset action (Sofie 2830)

packages/timeline-state-resolver-types/src/generated/vizMSE.ts

@@ -71,12 +71,20 @@ export interface VizMSEOptions {
 
 export type SomeMappingVizMSE = Record<string, never>
 
+export interface VizResetPayload {
+	/**
+	 * Optional property
+	 */
+	activeRundownPlaylistId?: string
+}
+
 export interface ActivatePayload {
 	activeRundownPlaylistId: string
 	clearAll?: boolean
 }
 
 export enum VizMSEActions {
+	VizReset = 'vizReset',
 	PurgeRundown = 'purgeRundown',
 	Activate = 'activate',
 	StandDown = 'standDown',

packages/timeline-state-resolver/src/integrations/vizMSE/$schemas/actions.json

@@ -1,6 +1,24 @@
 {
 	"$schema": "../../../$schemas/action-schema.json",
 	"actions": [
+		{
+			"id": "vizReset",
+			"name": "Reset",
+			"description": "Purges all rundowns, clears the engine and reactivates the Viz playlist",
+			"destructive": true,
+			"timeout": 10000,
+			"payload": {
+				"type": "object",
+				"properties": {
+					"activeRundownPlaylistId": {
+						"name": "Rundown playlist ID",
+						"description": "Optional property that helps track what rundown is active for optimisation reasons",
+						"type": "string"
+					}
+				},
+				"additionalProperties": false
+			}
+		},
 		{
 			"id": "purgeRundown",
 			"name": "Purge Viz Rundown",
@@ -15,8 +33,12 @@
 			"payload": {
 				"type": "object",
 				"properties": {
-					"activeRundownPlaylistId": { "type": "string" },
-					"clearAll": { "type": "boolean" }
+					"activeRundownPlaylistId": {
+						"type": "string"
+					},
+					"clearAll": {
+						"type": "boolean"
+					}
 				},
 				"required": ["activeRundownPlaylistId"],
 				"additionalProperties": false

packages/timeline-state-resolver/src/integrations/vizMSE/index.ts

@@ -20,6 +20,7 @@ import {
 	SomeMappingVizMSE,
 	TimelineContentVIZMSEElementPilot,
 	TimelineContentVIZMSEElementInternal,
+	VizResetPayload,
 } from 'timeline-state-resolver-types'
 
 import { createMSE, MSE } from '@tv2media/v-connection'
@@ -267,6 +268,15 @@ export class VizMSEDevice extends DeviceWithState<VizMSEState, DeviceOptionsVizM
 			commands: this._initOptions?.clearAllCommands || [],
 		})
 	}
+	public async resetViz(payload: VizResetPayload): Promise<void> {
+		await this.purgeRundown(true) // note - this might not be 100% necessary
+		await this.clearEngines()
+		await this._vizmseManager?.activate(payload?.activeRundownPlaylistId)
+
+		// lastly make sure we reset so timeline state is sent again
+		this.clearStates()
+		this.emit('resetResolver')
+	}
 
 	async executeAction(actionId: string, payload?: Record<string, any> | undefined): Promise<ActionExecutionResult> {
 		switch (actionId) {
@@ -280,6 +290,9 @@ export class VizMSEDevice extends DeviceWithState<VizMSEState, DeviceOptionsVizM
 			case VizMSEActions.ClearAllEngines:
 				await this.clearEngines()
 				return { result: ActionExecutionResultCode.Ok }
+			case VizMSEActions.VizReset:
+				await this.resetViz(payload ?? {})
+				return { result: ActionExecutionResultCode.Ok }
 			default:
 				return { result: ActionExecutionResultCode.Ok, response: t('Action "{{id}}" not found', { actionId }) }
 		}