Send Companion Feedback

Sends to the Companion OSC Server a JSON file describing the current state of the ATEM switcher.

MessageDescriptionArguments

/mixeffect/send-companion-feedback

Sends to the Companion OSC Server a JSON file describing the current state of the ATEM switcher.

None

The following settings must be set for each switcher connection.

  • Enable Companion Feedback: Toggle to enable sending of feedback to Companion.

  • Companion IP address: The IP address that is running Companion with the MixEffect native Companion module.

  • Companion Port: The port number associated with the MixEffect native Companion module.

The JSON file delivered to Companion will have the following format. Depending on the model of your switcher, more or less informatiom will be sent in the feedback object.

{
	"aux": [
		{
			"index": 0,
			"source": 4
		},
		{
			"index": 1,
			"source": 1
		}
	],
	"colorGenerators": [
		{
			"hue": 0,
			"saturation": 0,
			"luminance": 49.2,
			"index": 0
		},
		{
			"hue": 25.4,
			"saturation": 100,
			"luminance": 9.6,
			"index": 1
		}
	],
	"dsk": [
		{
			"index": 0,
			"keySource": 3011,
			"isAutoTransitioning": false,
			"invertKey": false,
			"inTransition": false,
			"tie": false,
			"isTowardsOnAir": true,
			"fillSource": 3010,
			"onAir": false,
			"masked": false,
			"rate": 15,
			"preMultiplied": false
		},
		{
			"index": 1,
			"keySource": 3021,
			"isAutoTransitioning": false,
			"invertKey": false,
			"inTransition": false,
			"tie": false,
			"isTowardsOnAir": true,
			"fillSource": 3020,
			"onAir": false,
			"masked": false,
			"rate": 30,
			"preMultiplied": false
		}
	],
	"fairlight": {
		"vfaEnabled": false,
		"canVfa": true,
		"sources": [
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 1
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 2
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 3
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 4
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 5
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 6
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 7
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 8
			},
			{
				"mixOption": 2,
				"isMixedIn": true,
				"sourceId": -256,
				"audioSource": 1301
			},
			{
				"mixOption": 2,
				"isMixedIn": true,
				"sourceId": -255,
				"audioSource": 1301
			},
			{
				"mixOption": 1,
				"isMixedIn": false,
				"sourceId": -65280,
				"audioSource": 1302
			}
		]
	},
	"macros": {
		"isLooping": false,
		"isRunning": false,
		"isWaiting": false,
		"isRecording": false,
		"macros": [
			{
				"index": 0,
				"name": "Auto"
			},
			{
				"index": 1,
				"name": "Lengthy Macro"
			},
			{
				"index": 2,
				"name": "Six Left (USK)"
			},
			{
				"index": 3,
				"name": "TEST"
			},
			{
				"index": 4,
				"name": "TEST Set All Setting"
			},
			{
				"index": 5,
				"name": "TEST"
			},
			{
				"index": 6,
				"name": "USK 1 On Air"
			},
			{
				"index": 7,
				"name": "USK 1 Off Air"
			},
			{
				"index": 8,
				"name": "Companion USK On"
			},
			{
				"index": 9,
				"name": "Set Chroma Thirds U4"
			},
			{
				"index": 10,
				"name": "Chroma Sample"
			},
			{
				"index": 11,
				"name": "USK 4 Off"
			},
			{
				"index": 12,
				"name": "Notes DVE"
			},
			{
				"index": 13,
				"name": "Companion USK Off"
			},
			{
				"index": 14,
				"name": "DSK Auto"
			},
			{
				"index": 15,
				"name": "Companion USK1 Only "
			},
			{
				"index": 16,
				"name": "Source: Streaming"
			},
			{
				"index": 17,
				"name": "Source: Zoom"
			},
			{
				"index": 18,
				"name": "Config for Streaming"
			},
			{
				"index": 19,
				"name": "Config for Gaming"
			},
			{
				"index": 20,
				"name": "Config for ZoomISO"
			},
			{
				"index": 21,
				"name": "FTB"
			},
			{
				"index": 22,
				"name": "Reset MP2 ZoomISO"
			},
			{
				"index": 23,
				"name": "Intro Live"
			},
			{
				"index": 24,
				"name": "Gaming SuperSource"
			},
			{
				"index": 25,
				"name": "Reset SuperSource ar"
			},
			{
				"index": 26,
				"name": "Macro 27"
			},
			{
				"index": 27,
				"name": "Audio Live ZoomISO"
			},
			{
				"index": 28,
				"name": "Audio Off ZoomISO"
			},
			{
				"index": 29,
				"name": "Mac Mini DVE 1"
			},
			{
				"index": 30,
				"name": "iPad DVE"
			},
			{
				"index": 31,
				"name": "USK 1 Off Air"
			},
			{
				"index": 32,
				"name": "Stream Intro Start"
			},
			{
				"index": 33,
				"name": "Stream Intro End"
			},
			{
				"index": 34,
				"name": "Zoom Audio 1"
			},
			{
				"index": 35,
				"name": "Zoom Audio 1-2"
			},
			{
				"index": 36,
				"name": "Zoom Audio 1-3"
			},
			{
				"index": 37,
				"name": "Zoom Audio 1-4"
			},
			{
				"index": 38,
				"name": "Five Grid USK 1 (Z4)"
			},
			{
				"index": 39,
				"name": "Five Grid USK Off"
			},
			{
				"index": 40,
				"name": "Two Horizontal Title"
			},
			{
				"index": 41,
				"name": "DSK 1 Off"
			},
			{
				"index": 42,
				"name": "Six Grid (ZoomISO+)"
			},
			{
				"index": 43,
				"name": "Six Grid Off"
			},
			{
				"index": 44,
				"name": "Enable Chat Overlay"
			},
			{
				"index": 45,
				"name": "Disable Chat Overlay"
			},
			{
				"index": 46,
				"name": "Chroma Test"
			},
			{
				"index": 48,
				"name": "Long Macro"
			},
			{
				"index": 49,
				"name": "AUX: Mac Mini"
			},
			{
				"index": 50,
				"name": "AUX: MultiView"
			},
			{
				"index": 52,
				"name": "Macro 53"
			},
			{
				"index": 89,
				"name": "6up USK3+4"
			},
			{
				"index": 90,
				"name": "Test"
			},
			{
				"index": 91,
				"name": "Macro 3"
			},
			{
				"index": 92,
				"name": "Macro 4"
			},
			{
				"index": 95,
				"name": "Save green"
			},
			{
				"index": 97,
				"name": "Audio Off"
			},
			{
				"index": 98,
				"name": "Test"
			},
			{
				"index": 99,
				"name": "Move Pattern USK"
			}
		]
	},
	"me": [
		{
			"transitionDve": {
				"logoRate": 25,
				"style": 34,
				"fillSource": 3020,
				"reverse": false,
				"rate": 25,
				"flipFlop": false,
				"keySource": 3020,
				"preMultiplied": true,
				"enableKey": false,
				"invertKey": false
			},
			"preview": 3010,
			"transitionDip": {
				"dipSource": 0,
				"rate": 45
			},
			"transitionMix": {
				"rate": 30
			},
			"index": 0,
			"inTransition": false,
			"transitionSting": {
				"source": 1,
				"triggerPoint": 34,
				"clipDuration": 73,
				"mixRate": 5,
				"preMultiplied": true,
				"preRoll": 2,
				"invertKey": false
			},
			"ftbInTransition": false,
			"backgroundState": 1,
			"transitionWipe": {
				"pattern": 2,
				"flipFlop": false,
				"fillSource": 0,
				"reverse": false,
				"rate": 85
			},
			"usk": [
				{
					"keyState": 0,
					"left": -16,
					"right": 16,
					"index": 0,
					"keySource": 3011,
					"chromaAdvanced": {
						"sampleCb": 41.34,
						"blue": -34,
						"red": -27.5,
						"flareSuppression": 30.8,
						"sampleY": 172.07,
						"green": 26.2,
						"foreground": 35.9,
						"background": 18.9,
						"spillSuppression": 26.7,
						"saturation": 120.7,
						"sampleCr": 25.88,
						"contrast": -26.5,
						"brightness": 16.9,
						"keyEdge": 52.8
					},
					"flyEnabled": false,
					"fillSource": 5,
					"type": 3,
					"dve": {
						"borderHue": 111.8,
						"masked": false,
						"borderInnerSoftness": 34,
						"borderInnerWidth": 12.1,
						"lightSourceAltitude": 25,
						"borderOuterWidth": 13,
						"top": 0,
						"right": 0,
						"borderBevelSoftness": 0,
						"borderBevelPosition": 0,
						"borderEnabled": true,
						"shadow": false,
						"borderSaturation": 100,
						"posX": 12.5,
						"sizeY": 0.169,
						"borderOpacity": 52,
						"borderLuma": 51.6,
						"left": 0,
						"bottom": 0,
						"borderOuterSoftness": 39,
						"sizeX": 0.169,
						"borderStyle": 0,
						"lightSourceDirection": 360,
						"posY": -3.5
					},
					"canFlyKey": true,
					"pattern": {
						"symmetry": 50,
						"pattern": 6,
						"size": 50,
						"posX": 0.5,
						"softness": 83,
						"invertPattern": false,
						"posY": 0.5
					},
					"bottom": -9,
					"masked": false,
					"onAir": false,
					"luma": {
						"invertKey": false,
						"preMultiplied": true
					},
					"top": 9
				},
				{
					"keyState": 0,
					"left": -16,
					"right": 16,
					"index": 1,
					"keySource": 3011,
					"chromaAdvanced": {
						"sampleCb": 41.34,
						"blue": 0,
						"red": 0,
						"flareSuppression": 0,
						"sampleY": 172.07,
						"green": 0,
						"foreground": 0,
						"background": 0,
						"spillSuppression": 0,
						"saturation": 100,
						"sampleCr": 25.88,
						"contrast": 0,
						"brightness": 0,
						"keyEdge": 50
					},
					"flyEnabled": false,
					"fillSource": 6,
					"type": 3,
					"dve": {
						"borderHue": 0,
						"masked": false,
						"borderInnerSoftness": 0,
						"borderInnerWidth": 0.2,
						"lightSourceAltitude": 25,
						"borderOuterWidth": 0,
						"top": 0,
						"right": 0,
						"borderBevelSoftness": 0,
						"borderBevelPosition": 0,
						"borderEnabled": false,
						"shadow": false,
						"borderSaturation": 0,
						"posX": 12.5,
						"sizeY": 0.169,
						"borderOpacity": 100,
						"borderLuma": 0,
						"left": 0,
						"bottom": 0,
						"borderOuterSoftness": 0,
						"sizeX": 0.169,
						"borderStyle": 0,
						"lightSourceDirection": 360,
						"posY": -7
					},
					"canFlyKey": true,
					"pattern": {
						"symmetry": 50,
						"pattern": 6,
						"size": 50,
						"posX": 0.5,
						"softness": 83,
						"invertPattern": false,
						"posY": 0.5
					},
					"bottom": -9,
					"masked": false,
					"onAir": false,
					"luma": {
						"invertKey": false,
						"preMultiplied": true
					},
					"top": 9
				},
				{
					"keyState": 0,
					"left": -16,
					"right": 16,
					"index": 2,
					"keySource": 3011,
					"chromaAdvanced": {
						"sampleCb": 41.34,
						"blue": 0,
						"red": 0,
						"flareSuppression": 0,
						"sampleY": 172.07,
						"green": 0,
						"foreground": 0,
						"background": 0,
						"spillSuppression": 0,
						"saturation": 100,
						"sampleCr": 25.88,
						"contrast": 0,
						"brightness": 0,
						"keyEdge": 50
					},
					"flyEnabled": false,
					"fillSource": 1,
					"type": 3,
					"dve": {
						"borderHue": 0,
						"masked": false,
						"borderInnerSoftness": 0,
						"borderInnerWidth": 0.2,
						"lightSourceAltitude": 25,
						"borderOuterWidth": 0,
						"top": 0,
						"right": 0,
						"borderBevelSoftness": 0,
						"borderBevelPosition": 0,
						"borderEnabled": true,
						"shadow": false,
						"borderSaturation": 0,
						"posX": 8.232,
						"sizeY": 0.414,
						"borderOpacity": 100,
						"borderLuma": 0,
						"left": 0,
						"bottom": 0,
						"borderOuterSoftness": 0,
						"sizeX": 0.414,
						"borderStyle": 0,
						"lightSourceDirection": 360,
						"posY": 4.048
					},
					"canFlyKey": true,
					"pattern": {
						"symmetry": 50,
						"pattern": 6,
						"size": 50,
						"posX": 0.5,
						"softness": 83,
						"invertPattern": false,
						"posY": 0.5
					},
					"bottom": -9,
					"masked": false,
					"onAir": false,
					"luma": {
						"invertKey": false,
						"preMultiplied": true
					},
					"top": 9
				},
				{
					"keyState": 0,
					"left": -16,
					"right": 16,
					"index": 3,
					"keySource": 3011,
					"chromaAdvanced": {
						"sampleCb": 41.34,
						"blue": 0,
						"red": 0,
						"flareSuppression": 0,
						"sampleY": 172.07,
						"green": 0,
						"foreground": 0,
						"background": 0,
						"spillSuppression": 0,
						"saturation": 100,
						"sampleCr": 25.88,
						"contrast": 0,
						"brightness": 0,
						"keyEdge": 50
					},
					"flyEnabled": false,
					"fillSource": 3010,
					"type": 0,
					"dve": {
						"borderHue": 0,
						"masked": false,
						"borderInnerSoftness": 0,
						"borderInnerWidth": 0.2,
						"lightSourceAltitude": 25,
						"borderOuterWidth": 0,
						"top": 0,
						"right": 0,
						"borderBevelSoftness": 0,
						"borderBevelPosition": 0,
						"borderEnabled": true,
						"shadow": false,
						"borderSaturation": 0,
						"posX": 12.5,
						"sizeY": 0.2,
						"borderOpacity": 100,
						"borderLuma": 0,
						"left": 0,
						"bottom": 0,
						"borderOuterSoftness": 0,
						"sizeX": 0.2,
						"borderStyle": 0,
						"lightSourceDirection": 360,
						"posY": 7
					},
					"canFlyKey": true,
					"pattern": {
						"symmetry": 50,
						"pattern": 6,
						"size": 50,
						"posX": 0.5,
						"softness": 83,
						"invertPattern": false,
						"posY": 0.5
					},
					"bottom": -9,
					"masked": false,
					"onAir": false,
					"luma": {
						"invertKey": false,
						"preMultiplied": true
					},
					"top": 9
				}
			],
			"ftb": false,
			"program": 1,
			"transition": {
				"style": 0,
				"rate": 1
			}
		}
	],
	"mediaPool": {
		"stills": [
			{
				"index": 0,
				"filename": "companion-profile-title"
			},
			{
				"index": 1,
				"filename": "network-settings"
			},
			{
				"index": 8,
				"filename": "Capture 1"
			},
			{
				"index": 9,
				"filename": "Capture 2"
			},
			{
				"index": 10,
				"filename": "Two-Horizontal-Titles 2"
			},
			{
				"index": 11,
				"filename": "MixEffectLogo 17"
			},
			{
				"index": 13,
				"filename": "MixEffectLogo 2"
			},
			{
				"index": 14,
				"filename": "gaming-overlay 2"
			},
			{
				"index": 15,
				"filename": "title-20210919_113205.png"
			},
			{
				"index": 16,
				"filename": "10-3"
			},
			{
				"index": 17,
				"filename": "10-4"
			},
			{
				"index": 18,
				"filename": "11-0-Color-Day"
			},
			{
				"index": 19,
				"filename": "11-0-Big-Sur-Color-Night"
			}
		],
		"mp": [
			{
				"stillIndex": 11,
				"clipIndex": 0,
				"type": 1,
				"index": 0
			},
			{
				"stillIndex": 16,
				"clipIndex": 0,
				"type": 1,
				"index": 1
			}
		],
		"audioClips": [],
		"clipCapacity": 0,
		"clips": [],
		"stillCapacity": 20
	},
	"model": 17,
	"multiview": [
		{
			"index": 0,
			"layout": 13
		}
	],
	"name": "ATEM Mini Extreme ISO",
	"output": {
		"isoRecordAllInputs": false,
		"streaming": false,
		"recording": false,
		"recordInAllCameras": false,
		"useLowLatency": false
	},
	"section": "switcher",
	"sources": [
		{
			"id": 0,
			"outputSource": true,
			"keySource": true,
			"longName": "Black",
			"inputSource": false,
			"shortName": "BLK",
			"mediaSourceFillOnly": false,
			"me2AndFillSources": false,
			"auxSource": true,
			"superSourceBoxSource": true,
			"me1AndFillSources": true,
			"me4AndFillSources": false,
			"superSourceArtSource": true,
			"mediaSource": false,
			"inputSourceForHyperDeck": false,
			"multiviewSource": true,
			"me3AndFillSources": false
		},
		{
			"id": 1,
			"outputSource": false,