feat: updateProps only updates the valid properties (according to the…

… mask). Returns true if anything was changed
nrkno · Dec 7, 2019 · 7d48ff6 · 7d48ff6
1 parent 416a520
commit 7d48ff6
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 26 deletions.
diff --git a/src/__tests__/index.spec.ts b/src/__tests__/index.spec.ts
@@ -41,7 +41,7 @@ test('setSuperSourceProperties - 7.2', async () => {
 		expect(conn.sendCommand).toHaveBeenCalledTimes(1)
 		expect(conn.sendCommand).toHaveBeenNthCalledWith(1, {
 			flag: 12,
-			properties: {
+			_properties: {
 				artOption: 0,
 				artPreMultiplied: true
 			}
@@ -64,7 +64,7 @@ test('setSuperSourceProperties - 8.0', async () => {
 		expect(conn.sendCommand).toHaveBeenNthCalledWith(1, {
 			ssrcId: 2,
 			flag: 12,
-			properties: {
+			_properties: {
 				artOption: 0,
 				artPreMultiplied: true
 			}
@@ -86,7 +86,7 @@ test('setSuperSourceBorder - 7.2', async () => {
 		expect(conn.sendCommand).toHaveBeenCalledTimes(1)
 		expect(conn.sendCommand).toHaveBeenNthCalledWith(1, {
 			flag: 139264,
-			properties: {
+			_properties: {
 				borderBevelSoftness: 12,
 				borderLuma: 3
 			}
@@ -109,7 +109,7 @@ test('setSuperSourceBorder - 8.0', async () => {
 		expect(conn.sendCommand).toHaveBeenNthCalledWith(1, {
 			ssrcId: 2,
 			flag: 1088,
-			properties: {
+			_properties: {
 				borderBevelSoftness: 12,
 				borderLuma: 3
 			}

diff --git a/src/commands/Audio/AudioMixerInputCommand.ts b/src/commands/Audio/AudioMixerInputCommand.ts
@@ -17,7 +17,6 @@ export class AudioMixerInputCommand extends WritableCommand<AudioChannel> {
 		super()
 
 		this.index = index
-		this.properties = {}
 	}
 
 	serialize () {

diff --git a/src/commands/CommandBase.ts b/src/commands/CommandBase.ts
@@ -27,10 +27,14 @@ export abstract class BasicWritableCommand<T> implements ISerializableCommand {
 	static readonly MaskFlags?: { [key: string]: number }
 	static readonly minimumVersion?: ProtocolVersion
 
-	properties: T
+	protected _properties: T
+
+	public get properties (): Readonly<T> {
+		return this._properties
+	}
 
 	constructor (properties: T) {
-		this.properties = properties
+		this._properties = properties
 	}
 
 	abstract serialize (version: ProtocolVersion): Buffer
@@ -47,24 +51,24 @@ export abstract class WritableCommand<T> extends BasicWritableCommand<Partial<T>
 		this.flag = 0
 	}
 
-	public updateProps (newProps: Partial<T>) {
-		this._updateProps(newProps)
+	public updateProps (newProps: Partial<T>): boolean {
+		return this._updateProps(newProps)
 	}
 
-	protected _updateProps (newProps: Object) {
-		this.properties = {
-			...this.properties,
-			...newProps
-		}
+	protected _updateProps (newProps: { [key: string]: any }): boolean {
 		const maskFlags = (this.constructor as any).MaskFlags as { [key: string]: number }
-
+		let hasChanges = false
 		if (maskFlags) {
 			for (const key in newProps) {
+				const key2 = key as keyof T
 				if (key in maskFlags) {
 					this.flag = this.flag | maskFlags[key]
+					this._properties[key2] = newProps[key]
+					hasChanges = true
 				}
 			}
 		}
+		return hasChanges
 	}
 
 }
diff --git a/src/commands/Inputs/InputPropertiesCommand.ts b/src/commands/Inputs/InputPropertiesCommand.ts
@@ -19,7 +19,6 @@ export class InputPropertiesCommand extends WritableCommand<InputChannel> {
 		super()
 
 		this.inputId = inputId
-		this.properties = {}
 	}
 
 	serialize () {

diff --git a/src/commands/Media/MediaPlayerStatusCommand.ts b/src/commands/Media/MediaPlayerStatusCommand.ts
@@ -8,7 +8,7 @@ export class MediaPlayerStatusCommand extends WritableCommand<MediaPlayer> {
 		playing: 1 << 0,
 		loop: 1 << 1,
 		atBeginning: 1 << 2,
-		frame: 1 << 3
+		clipFrame: 1 << 3
 	}
 	static readonly rawName = 'SCPS'
 

diff --git a/src/commands/MixEffects/FadeToBlack/FadeToBlackRateCommand.ts b/src/commands/MixEffects/FadeToBlack/FadeToBlackRateCommand.ts
@@ -11,7 +11,6 @@ export class FadeToBlackRateCommand extends BasicWritableCommand<{ rate: number
 		super({ rate })
 
 		this.mixEffect = mixEffect
-		this.properties = { rate }
 	}
 
 	serialize () {

diff --git a/src/commands/MixEffects/Key/MixEffectKeyDVECommand.ts b/src/commands/MixEffects/Key/MixEffectKeyDVECommand.ts
@@ -42,7 +42,6 @@ export class MixEffectKeyDVECommand extends WritableCommand<UpstreamKeyerDVESett
 
 		this.mixEffect = mixEffect
 		this.upstreamKeyerId = upstreamKeyerId
-		this.properties = {}
 	}
 
 	serialize () {

diff --git a/src/commands/MixEffects/Key/MixEffectKeyTypeSetCommand.ts b/src/commands/MixEffects/Key/MixEffectKeyTypeSetCommand.ts
@@ -3,7 +3,7 @@ import { UpstreamKeyerTypeSettings } from '../../../state/video/upstreamKeyers'
 
 export class MixEffectKeyTypeSetCommand extends WritableCommand<UpstreamKeyerTypeSettings> {
 	static MaskFlags = {
-		keyType: 1 << 0,
+		mixEffectKeyType: 1 << 0,
 		flyEnabled: 1 << 1
 	}
 

diff --git a/src/commands/__tests__/index.spec.ts b/src/commands/__tests__/index.spec.ts
@@ -340,7 +340,9 @@ const commandConverters: CommandTestConverterSet = {
 			'mixEffect': 'mixEffectIndex',
 			'upstreamKeyerId': 'keyerIndex'
 		},
-		propertyAliases: {}
+		propertyAliases: {
+			'keyType': (v: number) => ({ val: v, name: 'mixEffectKeyType' })
+		}
 	},
 	'KeOn': {
 		idAliases: {
@@ -644,11 +646,7 @@ const commandConverters: CommandTestConverterSet = {
 		idAliases: {
 			'mediaPool': 'index'
 		},
-		propertyAliases: {},
-		customMutate: (obj: any) => {
-			obj.frames = []
-			return obj
-		}
+		propertyAliases: {}
 	},
 	'SMPC': {
 		idAliases: {