Feat/vmix media reload retrying

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

@@ -9,9 +9,9 @@ export interface VMixOptions {
 	host: string
 	port: number
 	/**
-	 * How often, in milliseconds, to try re-sending certain failed commands. Defaults to 10 seconds. Set to 0 to disable. As of June 9th, 2023, this only works for media loading commands.
+	 * How often, in milliseconds, for when we should poll vMix to query its actual state. Used to know when to re-send certain failed commands. Values <= 0 disables the polling. Defaults to 10000ms.
 	 */
-	retryInterval?: number
+	pollInterval?: number
 }
 
 export interface MappingVmixProgram {

packages/timeline-state-resolver/src/integrations/vmix/$schemas/options.json

@@ -11,10 +11,10 @@
 			"type": "integer",
 			"ui:title": "Port"
 		},
-		"retryInterval": {
+		"pollInterval": {
 			"type": "number",
-			"ui:title": "Retry Interval",
-			"description": "How often, in milliseconds, to try re-sending certain failed commands. Defaults to 10 seconds. Set to 0 to disable. As of June 9th, 2023, this only works for media loading commands."
+			"ui:title": "Poll Interval",
+			"description": "How often, in milliseconds, for when we should poll vMix to query its actual state. Used to know when to re-send certain failed commands. Values <= 0 disables the polling. Defaults to 10000ms."
 		}
 	},
 	"required": ["host", "port"],

packages/timeline-state-resolver/src/integrations/vmix/__tests__/vmix.spec.ts

@@ -97,6 +97,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -267,6 +268,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -568,6 +570,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -811,6 +814,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -1121,6 +1125,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -1471,6 +1476,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -1697,6 +1703,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -1825,6 +1832,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -1950,6 +1958,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2075,6 +2084,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2201,6 +2211,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2331,6 +2342,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2462,6 +2474,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2587,6 +2600,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 8099,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2714,6 +2728,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2818,6 +2833,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -2942,6 +2958,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -3020,6 +3037,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -3120,6 +3138,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -3221,6 +3240,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -3339,6 +3359,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),
@@ -3467,6 +3488,7 @@ describe('vMix', () => {
 				options: {
 					host: '127.0.0.1',
 					port: 9999,
+					pollInterval: 0,
 				},
 				commandReceiver: commandReceiver0,
 			}),

packages/timeline-state-resolver/src/integrations/vmix/__tests__/vmixAPI.spec.ts

@@ -74,6 +74,11 @@ describe('vMixAPI', () => {
 						panY: 0,
 						zoom: 1,
 					},
+					listFilePaths: undefined,
+					name: 'Cam 1',
+					overlays: undefined,
+					playing: true,
+					solo: false,
 				},
 				'2': {
 					number: 2,
@@ -92,6 +97,11 @@ describe('vMixAPI', () => {
 						panY: 0,
 						zoom: 1,
 					},
+					listFilePaths: undefined,
+					name: 'Cam 2',
+					overlays: undefined,
+					playing: true,
+					solo: false,
 				},
 			},
 			overlays: [

packages/timeline-state-resolver/src/integrations/vmix/connection.ts

@@ -31,6 +31,14 @@ export interface Response {
 	body?: string
 }
 
+/**
+ * This TSR integration polls the state of vMix and merges that into our last-known state.
+ * However, not all state properties can be retried from vMix's API.
+ * Therefore, there are some properties that we must "carry over" from our last-known state, every time.
+ * These are those property keys for the Input state objects.
+ */
+export type InferredPartialInputStateKeys = 'filePath' | 'fade' | 'audioAuto' | 'restart'
+
 export class BaseConnection extends EventEmitter<ConnectionEvents> {
 	private _socket?: Socket
 	private _unprocessedLines: string[] = []
@@ -313,27 +321,55 @@ export class VMix extends BaseConnection {
 			version: xmlState['vmix']['version']['_text'],
 			edition: xmlState['vmix']['edition']['_text'],
 			inputs: _.indexBy(
-				(xmlState['vmix']['inputs']['input'] as Array<any>).map((input): VMixInput => {
-					fixedInputsCount++
-					return {
-						number: Number(input['_attributes']['number']),
-						type: input['_attributes']['type'],
-						state: input['_attributes']['state'],
-						position: Number(input['_attributes']['position']) || 0,
-						duration: Number(input['_attributes']['duration']) || 0,
-						loop: input['_attributes']['loop'] === 'False' ? false : true,
-						muted: input['_attributes']['muted'] === 'False' ? false : true,
-						volume: Number(input['_attributes']['volume'] || 100),
-						balance: Number(input['_attributes']['balance'] || 0),
-						audioBuses: input['_attributes']['audiobusses'],
-						transform: {
-							panX: Number(input['position'] ? input['position']['_attributes']['panX'] || 0 : 0),
-							panY: Number(input['position'] ? input['position']['_attributes']['panY'] || 0 : 0),
-							alpha: -1, // unavailable
-							zoom: Number(input['position'] ? input['position']['_attributes']['zoomX'] || 1 : 1), // assume that zoomX==zoomY
-						},
+				(xmlState['vmix']['inputs']['input'] as Array<any>).map(
+					(input): Required<Omit<VMixInput, InferredPartialInputStateKeys>> => {
+						fixedInputsCount++
+
+						let fixedListFilePaths: VMixInput['listFilePaths'] = undefined
+						if (input['_attributes']['type'] === 'VideoList') {
+							if (Array.isArray(input['list']['item'])) {
+								// Handles the case where there is more than one item in the list.
+								fixedListFilePaths = input['list']['item'].map((item) => item['_text'])
+							} else if (input['list']['item']) {
+								// Handles the case where there is exactly one item in the list.
+								fixedListFilePaths = [input['list']['item']['_text']]
+							}
+						}
+
+						let fixedOverlays: VMixInput['overlays'] = undefined
+						if (Array.isArray(input['overlay'])) {
+							// Handles the case where there is more than one item in the list.
+							fixedOverlays = input['overlay'].map((item) => parseInt(item['_attributes']['index'], 10))
+						} else if (input['overlay']) {
+							// Handles the case where there is exactly one item in the list.
+							fixedOverlays = [parseInt(input['overlay']['_attributes']['index'], 10)]
+						}
+
+						return {
+							number: Number(input['_attributes']['number']),
+							type: input['_attributes']['type'],
+							name: input['_attributes']['title'],
+							state: input['_attributes']['state'],
+							playing: input['_attributes']['state'] === 'Running',
+							position: Number(input['_attributes']['position']) || 0,
+							duration: Number(input['_attributes']['duration']) || 0,
+							loop: input['_attributes']['loop'] === 'False' ? false : true,
+							muted: input['_attributes']['muted'] === 'False' ? false : true,
+							volume: Number(input['_attributes']['volume'] || 100),
+							balance: Number(input['_attributes']['balance'] || 0),
+							solo: input['_attributes']['loop'] === 'False' ? false : true,
+							audioBuses: input['_attributes']['audiobusses'],
+							transform: {
+								panX: Number(input['position'] ? input['position']['_attributes']['panX'] || 0 : 0),
+								panY: Number(input['position'] ? input['position']['_attributes']['panY'] || 0 : 0),
+								alpha: -1, // unavailable
+								zoom: Number(input['position'] ? input['position']['_attributes']['zoomX'] || 1 : 1), // assume that zoomX==zoomY
+							},
+							overlays: fixedOverlays!,
+							listFilePaths: fixedListFilePaths!,
+						}
 					}
-				}),
+				),
 				'number'
 			),
 			overlays: (xmlState['vmix']['overlays']['overlay'] as Array<any>).map((overlay) => {