module.json

{
	"name": "WLEDAudioSync",
	"type": "UDP",
	"path": "Protocol",
	"version": "2.1.0",
	"description": "Stream Sound data to your WLED Sound Reactive",
	"url":"",
	"downloadURL": "",
	"hasInput": false,
	"hasOutput": true, 
	"hideDefaultCommands": false,
	"hideDefaultParameters": [
		"protocol",
		"autoAdd",
		"messageStructure",
		"firstValueIsTheName",
		"input"
	],
	
	"defaults": {
		"input":{
			"enabled": false
		},
		"autoAdd" : false,
		"protocol" : "Raw",
		"output":{
			"local": false,
			"remoteHost": "239.0.0.1",
			"remotePort" : 11988
		},
		"multicastMode": true
	},
	"parameters": {
		"IP Address to bind": {
			"type": "Enum",
			"description": "Bind Port to this IP address and send a test message.
	Used if you're in trouble to send to the Multicast Group",
			"default": "127.0.0.1",
			"readOnly": false,
			"options": {
				"127.0.0.1":"127.0.0.1"				
			}
		},
		"Send Test Message": {
			"type": "Trigger",
			"description": "Click to send test message to the Multicast Group",
		},
		"Live": {
			"type": "Boolean",
			"description": "Use live audio datas",
			"default": true
		},
		"Visualize live audio": {
			"type": "Trigger",
			"description": "Friture is a real-time audio analyzer.
	It works on Windows, macOS and Linux. It is free and open source.",
		},		
		"Audio V1": {
			"type": "Boolean",
			"description": "V1 message structure",
			"default": false
		},
		"Audio V2": {
			"type": "Boolean",
			"description": "V2 message structure",
			"default": true			
		},
		"Delay": {
			"type": "Integer",
			"description": "Delay to send audio data (ms) : max 256.
	Audio datas during the delay are lost",
			"default": 0,
			"min": 0,
			"max": 256
		},		
		"Volume Multiplier": {
			"type": "Float",
			"description": "Volume level multiplier",
			"default": 512,
			"min":0,
			"max":5120
		},
		"Frequency Magnitude Multiplier": {
			"type": "Float",
			"description": "Frequency magnitude level multiplier",
			"default": 254,
			"min":0,
			"max":2540
		},
		"Take Snapshot": {
			"type": "Trigger",
			"description": "Take a snapshot of audio data for replay",
		},
		"Beat Params":{
			"type": "Container",
			"description":"Aubio Beat BPM parameters",
			"collapsed": true,
			"Use BPM": {
				"type": "Boolean",
				"description": "Checked, will use custom Live BPM calculation received via OSC ",
				"default": false
			},
			"Aubio Buffer": {
				"type": "Integer",
				"description": "Select the size of the buffer used for beat detection. 
	A larger buffer is more accurate, but also more sluggish. 
	Refer to the aubio documentation of the tempo module for more details. 
	Example: -b 128",
				"default": 512,
				"min": 1,
				"max": 1024
			},			
			"Input audio": {
				"type": "Enum",
				"description": "Choose audio device name for input (first 9 only).
	Appear only if you click in Use BPM.
	You need to use it only if you want to bypass Chataigne's input audio or have some trouble.",
				"readOnly": false,
				"options" : {}
			},
			"Force reload": {
				"type": "Trigger",
				"description": "Re run the BPM calculation process with 'Input audio' data",
				"readOnly": false
			},
			"Script file": {
				"type": "File",
				"description": "OSC Script file name",
				"readOnly": false,
				"default" : "OSCBPM.js"
			},
			"Sync to beat": {
				"type":"Boolean",
				"description":" Check it to send UDP message synchronized to beat",
				"default":false
			},
			"Beat type": {
				"type": "Enum",
				"description": "Select odd, even, or both to send frame",
				"readOnly": false,
				"options" : {
						"Both":0,
						"Even":1,
						"Odd":2
				},
				"default":"Both"
			}
		},
		"RTMGC Params":{
			"type": "Container",
			"description":"Real Time Music Genre Classification parameters",
			"collapsed": true,
			"Use RTMGC": {
				"type": "Boolean",
				"description": "Checked, will use RTMGC
	Real Time Music Genre Classification",
				"default": false
			},
			"Include All Predictions": {
				"type": "Boolean",
				"description": "Check to include all prediction datas to determine the Most Probale Genre.
	Otherwise, only the first one (with 1.0 score) will be selected.",
				"default": false
			},			
			"Include BPM Data": {
				"type": "Boolean",
				"description": "Check to include probable genre from BPM to determine the Most Probale Genre ",
				"default": false
			},			
			"Server Port": {
				"type": "Integer",
				"description": "NodeJs server port : max 65536",
				"default": 8000,
				"min": 1,
				"max": 65536
			},
			"Script file": {
				"type": "File",
				"description": "OSC Script file name",
				"readOnly": false,
				"default" : "OSCRTMGC.js"
			}
		},
		"RTMMD Params":{
			"type": "Container",
			"description":"Real Time Music Mood Detection parameters",
			"collapsed": true,
			"Use RTMMD": {
				"type": "Boolean",
				"description": "Checked, will use RTMMD:
	Real Time Music Mood Detection",
				"default": false
			},
			"Show Screen": {
				"type": "Boolean",
				"description": "Show Emotion Color Map Screen",
				"default": true
			},
			"Verbose": {
				"type": "Boolean",
				"description": "Show verbose informations",
				"default": false
			},			
			"Script file": {
				"type": "File",
				"description": "OSC Script file name",
				"readOnly": false,
				"default" : "OSCRTMMD.js"
			}			
		}		
	},

	"values": {
		
		"beat":{
			
			"type":"Boolean",
			"description":"Value true of false at each beat.",
			"readOnly":true,
			"default":false
		}		
	},
	
	"scripts": [
		"WLEDAudioSync.js"
	],

	"commands": {

		"Snapshot":
		{
			"menu":"Replay",
			"callback":"runReplay",
			"parameters":{
				"File name":{
					"type":"File",
					"description": "Select audio data file to replay"
				},
				"Duration": {
					"type": "Integer",
					"description": "How many time for replay (ms) max 1500",
					"readOnly": false,
					"min": 1,
					"max": 1500
				}
			}
		},
		"WLED":
		{
			"menu":"FFT",
			"callback":"createWLEDFFT",
			"parameters":{
				"Old Style":{
					"type":"Boolean",
					"description": "Select old style FFT, otherwise new one",
					"default": false
				}
			}
		},
		"Custom":
		{
			"menu":"FFT",
			"callback":"createFFT",
			"parameters":{
				"Size": {
					"type": "Float",
					"description": "Select FFT size",
					"readOnly": false,
					"min": 0.01,
					"max": 1
				}
			}
		}		
	}	
}