module.json

{
	"name": "ADM-OSC",
	"type": "OSC",
	"path": "Immersive solution",
	"version": "1.5",
	"description": "Create a basic client/server that implement basic ADM-OSC communication with stable parameters.\n\nPlease visit https: //github.com/immersive-audio-live/ADM-OSC to know more about Live ADM-OSC initiative.\n\nChataigne Module specific documentation can be found in the README on GitHub:",
	"url": "https://github.com/madees/ADM-OSC-Chataigne-Module",
	"downloadURL": "https://github.com/madees/ADM-OSC-Chataigne-Module/archive/master.zip",
	"hasInput": true,
	"hasOutput": true,
	"hideDefaultCommands": false,
	"hideDefaultParameters": [
		"colorSendMode",
		"autoRange",
		"autoFeedback",
		"input",
		"outputs",
		"useHierarchy",
		"colorSendMode",
		"booleanSendMode"
	],
	"defaults": {
		"autoAdd": false,
		"oscInput": {
			"localPort": 4002
		},
		"OSC Outputs": {
			"OSC Output": {
				"local": true,
				"remoteHost": "192.168.1.1",
				"remotePort": 4001
			}
		}
	},
	"parameters": {
		"Number of objects": {
			"description": "Quantity of ojects properties values to receive.\n",
			"type": "Integer",
			"defaults": 64,
			"min": 1,
			"max": 128
		},
		"Get update Rate": {
			"description": "Automatically get the objects values updated from device.\nRate by second, default is 20 Hz (50ms interval).\n",
			"type": "Integer",
			"default": 20,
			"min": 1,
			"max": 50
		},
		"Get Sound Objects positions XYZ": {
			"description": "Update automatically objects container values.\n",
			"type": "Boolean",
			"default": false
		},
		"Get Sound Objects positions AED": {
			"description": "Update automatically objects container values.\n",
			"type": "Boolean",
			"default": false
		},
		"Get Sound Objects gain": {
			"description": "Update automatically objects container values.\n",
			"type": "Boolean",
			"default": false
		},
		"Get Sound Objects mute": {
			"description": "Update automatically objects container values.\n",
			"type": "Boolean",
			"default": false
		}
	},
	"scripts": [
		"ADM-OSC.js"
	],
	"values": {
		"Environement": {
			"type":"Container",
			"Change": {
				"description": "Last change in environment",
				"type": "String"
			}
			
		},
		"Listener": {
			"type":"Container",
			"xyz": {
				"description": "Listener head position",
				"type": "Point3D"
			},
			"ypr": {
				"description": "Listener head orientation",
				"type": "Point3D"
			}
		}
	},
	"commands": {
		"azim": {
			"menu": "Set objects",
			"callback": "azim",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"Azimuth angle": {
					"type": "Float",
					"min": -180,
					"max": 180
				}
			}
		},
		"elev": {
			"menu": "Set objects",
			"callback": "elev",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"Elevation angle": {
					"type": "Float",
					"min": -90,
					"max": 90
				}
			}
		},
		"dist": {
			"menu": "Set objects",
			"callback": "dist",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"Distance": {
					"type": "Float",
					"min": 0,
					"max": 1
				}
			}
		},
		"aed": {
			"menu": "Set objects",
			"callback": "aed",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"(A,E,D)": {
					"type": "Point3D",
					"min": [
						-180,
						-90,
						0
					],
					"max": [
						180,
						90,
						1
					]
				}
			}
		},
		"x": {
			"menu": "Set objects",
			"callback": "x",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"x": {
					"type": "Float",
					"min": -1,
					"max": 1
				}
			}
		},
		"y": {
			"menu": "Set objects",
			"callback": "y",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"y": {
					"type": "Float",
					"min": -1,
					"max": 1
				}
			}
		},
		"z": {
			"menu": "Set objects",
			"callback": "z",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"z": {
					"type": "Float",
					"min": -1,
					"max": 1
				}
			}
		},
		"xyz": {
			"menu": "Set objects",
			"callback": "xyz",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"xyz": {
					"type": "Point3D",
					"min": [
						-1,
						-1,
						-1
					],
					"max": [
						1,
						1,
						1
					]
				}
			}
		},
		"xy": {
			"menu": "Set objects",
			"callback": "xy",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"xy": {
					"type": "Point2D",
					"min": [
						-1,
						-1
					],
					"max": [
						1,
						1
					]
				}
			}
		},
		"gain": {
			"menu": "Set objects",
			"callback": "gain",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"Gain": {
					"type": "Float",
					"min": 0,
					"max": 1
				}
			}
		},
		"mute": {
			"menu": "Set objects",
			"callback": "mute",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"Is muted": {
					"type": "Boolean"
				}
			}
		},
		"w": {
			"menu": "Set objects",
			"callback": "w",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"w": {
					"type": "Float"
				}
			}
		},
		"dref": {
			"menu": "Set objects",
			"callback": "dref",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"dref": {
					"type": "Float",
					"min":0
				}
			}
		},
		"dmax": {
			"menu": "Set objects",
			"callback": "dmax",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"dmax": {
					"type": "Float",
					"min":0
				}
			}
		},
		"name": {
			"menu": "Set objects",
			"callback": "name",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				},
				"name": {
					"type": "String"
				}
			}
		},
		"change": {
			"menu": "Set env",
			"callback": "change",
			"parameters": {
				"change": {
					"type": "String"
				}
			}
		},
		"position": {
			"menu": "Set lis",
			"callback": "lisXYZ",
			"parameters": {
				"xyz": {
					"type": "Point3D"
				}
			}
		},
		"orientation": {
			"menu": "Set lis",
			"callback": "lisYPR",
			"parameters": {
				"ypr": {
					"type": "Point3D"
				}
			}
		},

		"Get azim": {
			"menu": "Get objects",
			"callback": "getAzim",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get elev": {
			"menu": "Get objects",
			"callback": "getElev",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get dist": {
			"menu": "Get objects",
			"callback": "getDist",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get aed": {
			"menu": "Get objects",
			"callback": "getAED",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get x": {
			"menu": "Get objects",
			"callback": "getX",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get y": {
			"menu": "Get objects",
			"callback": "getY",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get z": {
			"menu": "Get objects",
			"callback": "getZ",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get xy": {
			"menu": "Get objects",
			"callback": "getXY",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get xyz": {
			"menu": "Get objects",
			"callback": "getXYZ",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get gain": {
			"menu": "Get objects",
			"callback": "getGain",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get mute": {
			"menu": "Get objects",
			"callback": "getMute",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get dref": {
			"menu": "Get objects",
			"callback": "getDref",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get dmax": {
			"menu": "Get objects",
			"callback": "getMax",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get name": {
			"menu": "Get objects",
			"callback": "getName",
			"parameters": {
				"Source index": {
					"type": "Integer",
					"min": 1,
					"max": 128
				}
			}
		},
		"Get change": {
			"menu": "Get env",
			"callback": "getChange"
		},
		"Get lis XYZ": {
			"menu": "Get lis",
			"callback": "getLisXYZ"
		},
		"Get lis YPR": {
			"menu": "Get lis",
			"callback": "getLisYPR"
		}


	}
}