MOTU AVB Datastore API The Datastore JSON over HTTP Interface AVB Web API.pdf · The resulting JSON...

MOTUAVBDatastoreAPIMOTUAVBdevicesareequippedwithapowerfulAPIforhardwarecontrolandmonitoring.ThisdocumentcoversAPIversion0.0.0.

TheDatastoreThedevice'sparametersarestoredinakey-valuestorecalledthedatastore.Allparametersofinterestareexposedasakeyinthedatastore.Eachkeyinthedatastoreisaseriesof/-separatedpathcomponents.Forexample,mix/aux/7/eq/highshelf/freqrepresentsthe8thauxchannel'shighshelffrequencyintheEQeffect.Allindicesare0-based.

JSONoverHTTPInterfaceThefulldatastoreisaccessibleviaJSON(http://en.wikipedia.org/wiki/JSON)overHTTP(http://en.wikipedia.org/wiki/HTTP).ThissectiondescribesthebasicsoftheAPIthroughaseriesofexamplecurl(http://curl.haxx.se/)commands.

Basics

ThedevicehostsHTTPaccesstothedatastorethroughthe/datastorepath.TogettheentirecontentsofthedatastoreasJSON,simplyGET/datastore:

>curl<yourdevice.local.>/datastore(thefulldatastore)

Togetthecontentsofasubtreeofthedatastore,simplyappendthatsubtreetotheURL.Forexample,togetallthesettingsrelatedtothegateeffectonchannel17:

>curl<yourdevice.local.>/datastore/mix/chan/16/gate{"release":500.000000,"enable":0.000000,"attack":100.000000,"threshold":0.1}

Again,notethatallindicesare0-based.Togetthevalueforasinglekey,appendthefulldatastorepathtothedatastoreURL.TheresultingJSONobjectwillhaveasinglevalue,underakeynamed"value".Forexample,togetthenameofthethirdoutputbank:

>curl<yourdevice.local.>/datastore/ext/obank/2/name{"value":"ADATA"}

Makingchangestothedatastore

ChangestothedatastorearemadewiththeHTTPPATCHverb.POSTisalsosupportedandbehavesidenticallyforclientsthat

donotsupportPATCH.TheAPIforsettingvaluesmirrorsthatforgettingthem:clientscanPATCHthedatastoreroot,asubtree,orasinglevalue.Thedatamustbeform-encoded,withaformfieldnamed"json"containingaJSON-encodedobjectwiththekey/valuepairstochange.Ifyouaresettingasinglevalue,theJSONobjectshouldhaveonekeynamed"value".

Someexamples:

Settingasinglevalue

Thiscommandsetsthenameofthefirstchannelofthethirdoutputbank:

>curl--data'json={"value":"Myfavoritechannel"}'\<yourdevice.local.>/datastore/ext/obank/2/ch/0/name

Settingmultiplevaluesonthesamesubtree

Thiscommandsetsthenamesofthefirstandsecondchannelsinthethirdoutputbank:

>curl--data'json={"ch/0/name":"TheBestofChannels","ch/1/name":"TheWorstofChannels"}'\<yourdevice.local.>/datastore/ext/obank/2/

Settingmultiplevalueswithfullpaths

Thiscommandsetsthenameofthefirstchannelonthethirdoutputbank,andenablesthegateeffectonthefirstmixerchannel.

>curl--data'json={"ext/obank/2/ch/0/name":"Iguessthischannelisfine","mix/chan/0/gate/enable":1}'\<yourdevice.local.>/datastore

ETagsandLongPolling

ThewholedatastorehasaHTTPETag(http://en.wikipedia.org/wiki/HTTP_ETag)representingthenumberoftimesthedatastorehaschangedsinceboot.Eachtimeaparameterischanged,thisglobalETagisincremented.Forexample,inthiscasetheETagis5678:

>curl-s-D-<yourdevice.local.>/datastore-o/dev/null#onlyshowheadersHTTP/1.1200OKConnection:Keep-AliveTransfer-Encoding:chunkedETag:5678Content-Type:application/jsonCache-Control:no-cache

Afterthenextchangetothedatastore,theETagwillbeincrementedto5679.

Tosupportlongpolling,thedevicehasspecialbehaviorwhentherequestincludesanIf-None-Matchheader.Ifthecurrent

datastoreETagisnewer(i.e.,greaterinnumber)thanthesentIf-None-MatchETag,thedevicewillrespondimmediately.

>curl-H"If-None-Match:5670"<yourdevice.local.>/datastore/ext/obank/2/name{"value":"ADATA"}

IftheIf-None-MatchETagisequaltothecurrentETag,thedevicewillnotrespondfor15seconds.If15secondselapsewithoutachange,itwillrespondwith304NotModified.

However,ifthedatastorechangesduringthe15secondwaitperiod,thedevicewillimmediatelyrespondwithallchangessincetheETagpassedintheIf-None-Matchheader.Thiscombinationofbehaviorsenablesclientstobenotifiedofchangeswithlowlatencyandalowpollingfrequency.

TheClientID

Additionally,clientsmaypassinaclientIDinaquerystringvariablenamed"client".TheclientIDmustbeanumberrepresentablebya32-bitunsignedinteger(i.e.,intherange$0$to$2^{32}-1$).DatastorechangesmadebyPATCHandPOSTrequestswithagivenclientIDwillbefilteredoutofalllongpollingGETrequestswiththesameclientID.Thismaybeconvenientforclientswhichdonotwaitforaround-tripbeforechangingtheuser-visibleUI.WerecommendchoosingarandomintegerinthisrangeandusingthatasyourclientIDforthedurationofyoursession.

Example:

>curl<yourdevice.local.>/datastore?client=1479701624

DatastoreTypesEachdatastorepathhasanassignedtype.EachPUTorPOSTtoapathmustcontaindatathatmatchesthetypeforthatpath.

stringautf8string,with'\','"',andcontrolcodesescapedwitha'\',accordingtotheJSONspec(http://en.wikipedia.org/wiki/JSON).realafloatingpointnumberintanintegersemverasemver(http://semver.org/)versionstring,e.g.1.0.6+1234

Anytypecanbemodifiedbythefollowing"typemodifiers"byappending<_modifier>tothetype:

listastringcontainingcolonseparatedlistofobjects-notethate.g.int_listisrepresentedbystring,buteachcomponentmustbeconvertabletoaninteger.pairastringcontainingacolon-separatedpairofobjects.optanoptionalobject(i.e.theobjectmaynotexistinthedatastore)boolThisisaspecialmodifierthatmeans0indicates"false",whileanyothervalueindicates"true".enumAspecialmodifierthatindicatesthepathcanonlytakeoneofafinitenumberofvalues.Thepotentialvaluesaredocumentedalongwiththepath.

DatastorePermissionsEachdatastorepathhasapermission:either'r'(read)or'rw'(read/write).Clientscanonlychangeparametersmarked'rw'.

VersioningEachsectionofdatastoreparametershasaseparatesemverversionassociatedwithit.Foreachsection,thecurrentdatastoreversionforthatsectionlivesinext/caps/<section>.Forexample,theversionfortheavbsectionappearsatext/caps/avb.Iftheversionpathdoesn'texist,thatsectiondoesnotexistonthedevice.

Eachpathisdocumentedwiththefirstversioninwhichitappeared.Anyothercompatibilitynotesarementionedinthedescriptionsection.Inkeepingwiththesemverdescription,anybreakingchangewillresultinanincrementofthemajorversion,whilenon-breakingchangessuchasfeatureadditionswillcausetheminorversiontoincrement.

TheHTTPprotocolusedtoquerydatastorepathsandthesectionsinthe"global"sectionarebothversionedbyan"apiversion"parameterwhichlivesoutsidetheDatastoreAPI.TheeasiestwaytocheckthisnumberisbyaGETrequestto/apiversion.

>curl<yourdevice.local>/apiversion0.0.0

ThisdocumentationappliesspecificallytoglobalAPIversionsequaltoorabove0.0.0andbelow1.0.0.

DatastorePathPlaceholdersManydatastorepathsaredocumentedwithcertaincomponentsreplacedbyplaceholdersinanglebrackets(<>).Someoftheseplaceholderscanhavedifferentvaluesdependingontheexactmodelofdevice,andaresubjecttochangeeveninminorversions.Formixerandi/oparametersinparticular,makesureyoudoafulldatastorerequestfirsttoseeexactlywhichpathsareavailableonyourparticulardevice.

GlobalSettings

uid

Type:stringPermission:rAvailablesinceglobalversion:0.0.0Description:TheUIDofthedevice.TheUIDisa16digithexadecimalstringthatuniquelyidentifiesthisdeviceonAVBnetworks.

ext/caps/avb

Type:semver_optPermission:rAvailablesinceglobalversion:0.0.0Description:Theversionoftheavbsection.Ifthispathisabsent,thedevicedoesnothavethepathsintheavbsection.

ext/caps/router

Type:semver_optPermission:rAvailablesinceglobalversion:0.0.0Description:Theversionoftheroutersection.Ifthispathisabsent,thedevicedoesnothavethepathsintheroutersection.

ext/caps/mixer

Type:semver_optPermission:rAvailablesinceglobalversion:0.0.0Description:Theversionofthemixersection.Ifthispathisabsent,thedevicedoesnothavethepathsinthemixersection.

AVB(AudioVideoBridging)Settings

TheavbsectionofthedatastoreisspecialbecauseitincludesinformationonallAVBdevicesinthetargetdevice'sAVBnetwork,inadditiontothelocalparametersofthatdevice.Thelistofalldevicesexistsatavb/devs.Eachdeviceinthatlistmaintainsaseparatesubtree,containingallAVBparameters,locatedatavb/<uid>.AnyAVB-capabledevice--eventhosenotcreatedbyMOTU--willappearintheavbsection,althoughMOTU-onlyparameterssuchasapiversionandurlwillonlyappearforMOTUdevices.

avb/devs

Type:string_listPermission:rAvailablesinceavbversion:0.0.0Description:AlistofUIDsforAVBdevicesonthesamenetworkasthisdevice.

avb/<uid>/entity_model_id_h32

Type:intPermission:rAvailablesinceavbversion:0.0.0Description:ThevendoridoftheconnectedAVBdevice.

avb/<uid>/entity_model_id_l32

Type:intPermission:rAvailablesinceavbversion:0.0.0Description:ThemodelidoftheconnectedAVBdevice.

avb/<uid>/entity_name

Type:stringPermission:rwAvailablesinceavbversion:0.0.0Description:ThehumanreadablenameoftheconnectedAVBdevice.OnMOTUdevices,thismaybechangedbytheuseroranAPIclient(e.g.,"My1248").

avb/<uid>/model_name

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:ThehumanreadablemodelnameoftheconnectedAVBdevice(e.g.,"1248").

avb/<uid>/hostname

Type:string_optPermission:rAvailablesinceavbversion:0.0.0Description:Thesanitizedhostnameassignedtothisdevice.ThisisonlyvalidforMOTUdevices.Thismaybedifferentfromentity_nameinthatitwon'thavespacesornon-asciicharacters(e.g.,"My-1248").

avb/<uid>/master_clock/capable

Type:int_boolPermission:rAvailablesinceavbversion:0.0.0Description:TrueifthisdevicesupportsMOTUMasterClock.MOTUMasterClockisasetofspecialdatastorekeysintheavbsectionthatallowsonedevicetoquicklybecometheclocksourceofmanyothers.

avb/<uid>/master_clock/uid

Type:string_optPermission:rwAvailablesinceavbversion:0.0.0Description:TheUIDofthedevicethemaster_clockstreamisconnectedto,ortheemptystringifthereisnoconnection.OnlyavailablefordevicesthatareMasterClockcapable(seemaster_clock/capableabove).

avb/<uid>/vendor_name

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:ThehumanreadablevendornameoftheconnectedAVBdevice(e.g.,"MOTU").

avb/<uid>/firmware_version

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:ThehumanreadablefirmwareversionnumberoftheconnectedAVBdevice.ForMOTUdevices,thiswillbeasemver.

avb/<uid>/serial_number

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:ThehumanreadableserialnumberoftheconnectedAVBdevice.

avb/<uid>/controller_ignore

Type:int_boolPermission:rAvailablesinceavbversion:0.0.0Description:Trueifthisdeviceshouldbeignored.Iftrue,clientsshouldnotshowthisdeviceintheirUI.

avb/<uid>/acquired_id

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:ThecontrollerUIDofthecontrollerthatacquiredthisbox,ortheemptystringifnocontrollerhasacquiredit.AcquisitionisapartoftheAVBstandardthatallowsacontrollertopreventothercontrollersfrommakingchangesonthisdevice.YoucannotinitiateanacquisitionfromthedatastoreAPI,butyoushouldavoidmakingchangesonadevicethathasbeenacquiredelsewhere.

avb/<uid>/motu.mdns.type

Type:string_optPermission:rAvailablesinceavbversion:0.0.0Description:Thenameofthedevicefamilyforthisdevice(e.g.,"netiodevice").ThispathisonlyvalidforMOTUdevices.

avb/<uid>/apiversion

Type:semver_optPermission:rAvailablesinceavbversion:0.0.0Description:TheglobaldatastoreAPIversionofthedevice.ThispathisonlyvalidforMOTUdevices.

avb/<uid>/url

Type:string_optPermission:rAvailablesinceavbversion:0.0.0Description:Thecanonicalurlofthedevice.ThispathisonlyvalidforMOTUdevices.

avb/<uid>/current_configuration

Type:intPermission:rwAvailablesinceavbversion:0.0.0Description:Theindexofthecurrentlyactivedeviceconfiguration.MOTUdevicesonlyhaveoneconfiguration,index0.Otherdevicesmayhavemultipleavailableconfigurations.

avb/<uid>/cfg/<index>/object_name

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:Thenameoftheconfigurationwiththegivenindex.

avb/<uid>/cfg/<index>/identify

Type:int_boolPermission:rwAvailablesinceavbversion:0.0.0Description:Trueiftheconfigurationisinidentifymode.Whatidentifymodemeansdependsonthedevice.ForMOTUdevices,identifywillflashthefrontpanelbacklight.

avb/<uid>/cfg/<index>/current_sampling_rate

Type:intPermission:rwAvailablesinceavbversion:0.0.0Description:Thesamplingrateoftheconfigurationwiththegivenindex.

avb/<uid>/cfg/<index>/sample_rates

Type:int_listPermission:rAvailablesinceavbversion:0.0.0Description:Alistofallowedsampleratesfortheconfigurationwiththegivenindex.

avb/<uid>/cfg/<index>/clock_source_index

Type:intPermission:rwAvailablesinceavbversion:0.0.0Description:Thecurrentlychosenclocksourcefortheconfigurationwiththegivenindex.

avb/<uid>/cfg/<index>/clock_sources/num

Type:intPermission:rAvailablesinceavbversion:0.0.0Description:Thenumberofavailableclocksourcesforthegivenconfiguration.

avb/<uid>/cfg/<index>/clock_sources/<index>/object_name

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:Thenameoftheclocksourcewiththegivenindex.

avb/<uid>/cfg/<index>/clock_sources/<index>/type

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:Thetypeoftheclocksourcewiththegivenindex.Thevaluewillbeoneof"internal","external",or"stream".

avb/<uid>/cfg/<index>/clock_sources/<index>/stream_id

Type:int_optPermission:rAvailablesinceavbversion:0.0.0Description:Ifthetypeoftheclocksourceis"stream",theidofthestreamfromwhichitderivesitsclock.Thispathisonlyvalidiftheclockisastream.

avb/<uid>/cfg/<index>/<input_or_output>_streams/num

Type:intPermission:rAvailablesinceavbversion:0.0.0Description:ThenumberofavailableinputoroutputAVBstreams.

avb/<uid>/cfg/<index>/<input_or_output>_streams/<index>/object_name

Type:stringPermission:rAvailablesinceavbversion:0.0.0Description:Thenameoftheinputoroutputstreamwiththegivenindex

avb/<uid>/cfg/<index>/<input_or_output>_streams/<index>/num_ch

Type:intPermission:rAvailablesinceavbversion:0.0.0Description:Thenumberofchannelsontheinputoroutputstream.

avb/<uid>/cfg/<index>/input_streams/<index>/talker

Type:string_pair

Permission:rwAvailablesinceavbversion:0.0.0Description:Thetalkerforthegiveninputstream.ThefirstelementofthepairisthedeviceUID,thesecondelementofthepairisthestreamIDthatthisstreamisconnectedto.

ext/clockLocked

Type:int_boolPermission:rAvailablesinceavbversion:0.0.0Description:Trueiftheclockislocked.

RoutingandI/OSettings

ext/wordClockMode

Type:stringPermission:rwAvailablesincerouterversion:0.2.0Description:"1x"ifthewordclockoutshouldalwaysbea1xrateor"follow"ifitshouldalwaysfollowthesystemclock

ext/wordClockThru

Type:stringPermission:rwAvailablesincerouterversion:0.2.0Description:"thru"ifthewordclockoutputshouldbethesameasthewordclockinputor"out"ifitshouldbedeterminedbythesystemclock

ext/smuxPerBank

Type:int_boolPermission:rAvailablesincerouterversion:0.2.0Description:TrueifeachopticalbankhasitsownSMUXsetting

ext/vlimit/lookahead

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:TrueifvLimitlookaheadisenabled.vLimitlookaheadprovidesbetterinputlimiting,atthecostofsmallamountsofextralatency.ThispathisonlypresentondeviceswithaccesstovLimit.

ext/enableHostVolControls

Type:int_boolPermission:rwAvailablesincerouterversion:0.1.0Description:Trueifthecomptuterisallowedtocontrolthevolumesofcomptuer-to-devicestreams.

ext/maxUSBToHost

Type:intPermission:rwAvailablesincerouterversion:0.1.0Description:ValidonlywhenthisdeviceisconnectedtothecomputerviaUSB.Thischoosesthemaxnumberof

channels/maxsampleratetradeofffortheto/fromcomputerinput/outputbanks.

ext/<ibank_or_obank>/<index>/name

Type:stringPermission:rAvailablesincerouterversion:0.0.0Description:Thenameoftheinputoroutputbank

ext/<ibank_or_obank>/<index>/maxCh

Type:intPermission:rAvailablesincerouterversion:0.0.0Description:Themaximumpossiblenumberofchannelsintheinputoroutputbank.

ext/<ibank_or_obank>/<index>/numCh

Type:intPermission:rAvailablesincerouterversion:0.0.0Description:Thenumberofchannelsavailableinthisbankatitscurrentsamplerate.

ext/<ibank_or_obank>/<index>/userCh

Type:intPermission:rwAvailablesincerouterversion:0.0.0Description:Thenumberofchannelsthattheuserhasenabledforthisbank.

ext/<ibank_or_obank>/<index>/calcCh

Type:intPermission:rAvailablesincerouterversion:0.0.0Description:Thenumberofchannelsthatareactuallyactive.Thisisalwaystheminimumofext/<ibank_or_obank>/<index>/userChandext/<ibank_or_obank>/<index>/userCh.

ext/<ibank_or_obank>/<index>/smux

Type:stringPermission:rwAvailablesincerouterversion:0.2.0Description:ForOpticalbanks,either"toslink"or"adat"

ext/ibank/<index>/madiClock

Type:stringPermission:rAvailablesincerouterversion:0.2.0Description:ForMADIinputbanks,thisisthe2xclockmodeoftheinputstream--"1x"for48/44.1kHzframeclock,or"2x"for88.2/96kHzframeclock

ext/obank/<index>/madiClock

Type:stringPermission:rwAvailablesincerouterversion:0.2.0

Description:ForMADIoutputbanks,thisisthe2xclockmodeoftheoutputstream--"1x"for48/44.1kHzframeclock,or"2x"for88.2/96kHzframeclock

ext/ibank/<index>/madiFormat

Type:intPermission:rAvailablesincerouterversion:0.2.0Description:56or64representing56or64MADIchannelsat1x,28or32channelsat2x,or14or16channelsat4x,respectively

ext/obank/<index>/madiFormat

Type:intPermission:rwAvailablesincerouterversion:0.2.0Description:56or64representing56or64MADIchannelsat1x,28or32channelsat2x,or14or16channelsat4x,respectively

ext/<ibank_or_obank>/<index>/ch/<index>/name

Type:stringPermission:rwAvailablesincerouterversion:0.0.0Description:Thechannel'sname.

ext/obank/<index>/ch/<index>/src

Type:int_pair_optPermission:rwAvailablesincerouterversion:0.0.0Description:Iftheoutputchannelisconnectedtoaninputbank,a":"separatedpairintheform" :

",otherwise,ifunrouted,anemptystring.

ext/<ibank_or_obank>/<index>/ch/<index>/phase

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:Trueifthesignalhasitsphaseinverted.Thisisonlyapplicabletosomeinputoroutputchannels.

ext/<ibank_or_obank>/<index>/ch/<index>/pad

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:Trueifthe20dBpadisengaged.Thisisonlyapplicabletosomeinputoroutputchannels.

ext/ibank/<index>/ch/<index>/48V

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:Trueifthe48Vphantompowerisengaged.Thisisonlyapplicabletosomeinputchannels.

ext/ibank/<index>/ch/<index>/vlLimit

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:TrueifthevLimitlimiterisengaged.Thisisonlyapplicabletosomeinputchannels.

ext/ibank/<index>/ch/<index>/vlClip

Type:int_bool_optPermission:rwAvailablesincerouterversion:0.0.0Description:TrueifvLimitclipisengaged.Thisisonlyapplicabletosomeinputchannels.

ext/<ibank_or_obank>/<index>/ch/<index>/trim

Type:int_optPermission:rwAvailablesincerouterversion:0.0.0Description:AdB-valueforhowmuchtotrimthisinputoroutputchannel.Therangeofthisparameterisindicatedbyext/<ibank_or_obank>/<index>/ch/<index>/trimRange.Onlyavailableforcertaininputoroutputchannels.

ext/<ibank_or_obank>/<index>/ch/<index>/trimRange

Type:int_pair_optPermission:rwAvailablesincerouterversion:0.0.0Description:Apairoftheminimumfollowedbymaximumvaluesallowedforthetrimparameterontheinputoroutputchannel.

ext/<ibank_or_obank>/<index>/ch/<index>/stereoTrim

Type:int_optPermission:rwAvailablesincerouterversion:0.0.0Description:AdB-valueforhowmuchtotrimthisinputoroutputchannel.Thisstereotrimaffectboththischannelandthenextone.Therangeofthisparameterisindicatedbyext/<ibank_or_obank>/<index>/ch/<index>/stereoTrimRange.Onlyavailableforcertaininputoroutputchannels.

ext/<ibank_or_obank>/<index>/ch/<index>/stereoTrimRange

Type:int_pair_optPermission:rwAvailablesincerouterversion:0.0.0Description:ApairoftheminimumfollowedbymaximumvaluesallowedforthestereoTrimparameterontheinputoroutputchannel.

ext/<ibank_or_obank>/<index>/ch/<index>/connection

Type:int_bool_optPermission:rAvailablesincerouterversion:0.0.0Description:Trueifthechannelhasaphysicalconnectorpluggedin(e.g.,anaudiojack).Thisinformationmaynotbeavailableforallbanksordevices.

MixerSettings

Themixersectionasdescribedisonlyvalidforthecurrentmixerversion,1.0.Infutureversions,paths,types,orvalidparameterrangesmaychange.

mix/ctrls/dsp/usage

Type:intPermission:rAvailablesincemixerversion:1.0.0Description:TheapproximatepercentageofDSPresourcesusedformixingandeffects.

mix/ctrls/<effect_resource>/avail

Type:int_bool_optPermission:rAvailablesincemixerversion:1.0.0Description:TrueifthereareenoughDSPresourcestoenableonemoreofthegiveneffect.

mix/chan/<index>/matrix/aux/<index>/send

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0MaximumValue:4Unit:linear

mix/chan/<index>/matrix/group/<index>/send


mix/chan/<index>/matrix/reverb/<index>/send


mix/chan/<index>/matrix/aux/<index>/pan

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-1MaximumValue:1Unit:pan

mix/chan/<index>/matrix/group/<index>/pan

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-1MaximumValue:1

Unit:pan

mix/chan/<index>/matrix/reverb/<index>/pan

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-1MaximumValue:1Unit:pan

mix/chan/<index>/hpf/enable

Type:real_boolPermission:rwAvailablesincemixerversion:1.0.0

mix/chan/<index>/hpf/freq

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:20MaximumValue:20000Unit:Hz

mix/chan/<index>/eq/highshelf/enable


mix/chan/<index>/eq/highshelf/freq


mix/chan/<index>/eq/highshelf/gain

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-20MaximumValue:20Unit:dB

mix/chan/<index>/eq/highshelf/bw

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0.01MaximumValue:3

Unit:octaves

mix/chan/<index>/eq/highshelf/mode

Type:real_enumPermission:rwAvailablesincemixerversion:1.0.0PossibleValues:Shelf=0,Para=1

mix/chan/<index>/eq/mid1/enable


mix/chan/<index>/eq/mid1/freq


mix/chan/<index>/eq/mid1/gain


mix/chan/<index>/eq/mid1/bw

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0.01MaximumValue:3Unit:octaves

mix/chan/<index>/eq/mid2/enable


mix/chan/<index>/eq/mid2/freq


mix/chan/<index>/eq/mid2/gain


mix/chan/<index>/eq/mid2/bw


mix/chan/<index>/eq/lowshelf/enable


mix/chan/<index>/eq/lowshelf/freq


mix/chan/<index>/eq/lowshelf/gain


mix/chan/<index>/eq/lowshelf/bw


mix/chan/<index>/eq/lowshelf/mode


mix/chan/<index>/gate/enable


mix/chan/<index>/gate/release

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:50MaximumValue:2000Unit:ms

mix/chan/<index>/gate/threshold


mix/chan/<index>/gate/attack


mix/chan/<index>/comp/enable


mix/chan/<index>/comp/release


mix/chan/<index>/comp/threshold


mix/chan/<index>/comp/ratio

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:1MaximumValue:10

mix/chan/<index>/comp/attack


mix/chan/<index>/comp/trim


mix/chan/<index>/comp/peak

Type:real_enumPermission:rwAvailablesincemixerversion:1.0.0PossibleValues:RMS=0,Peak=1

mix/chan/<index>/matrix/enable


mix/chan/<index>/matrix/solo


mix/chan/<index>/matrix/mute


mix/chan/<index>/matrix/pan

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-1

MaximumValue:1Unit:pan

mix/chan/<index>/matrix/fader


mix/main/<index>/eq/highshelf/enable


mix/main/<index>/eq/highshelf/freq


mix/main/<index>/eq/highshelf/gain


mix/main/<index>/eq/highshelf/bw


mix/main/<index>/eq/highshelf/mode


mix/main/<index>/eq/mid1/enable


mix/main/<index>/eq/mid1/freq


mix/main/<index>/eq/mid1/gain


mix/main/<index>/eq/mid1/bw


mix/main/<index>/eq/mid2/enable


mix/main/<index>/eq/mid2/freq


mix/main/<index>/eq/mid2/gain


mix/main/<index>/eq/mid2/bw

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0.01

MaximumValue:3Unit:octaves

mix/main/<index>/eq/lowshelf/enable


mix/main/<index>/eq/lowshelf/freq


mix/main/<index>/eq/lowshelf/gain


mix/main/<index>/eq/lowshelf/bw


mix/main/<index>/eq/lowshelf/mode


mix/main/<index>/leveler/enable


mix/main/<index>/leveler/makeup

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0MaximumValue:100Unit:%

mix/main/<index>/leveler/reduction


mix/main/<index>/leveler/limit


mix/main/<index>/matrix/enable


mix/main/<index>/matrix/mute


mix/main/<index>/matrix/fader


mix/aux/<index>/eq/highshelf/enable


mix/aux/<index>/eq/highshelf/freq


mix/aux/<index>/eq/highshelf/gain

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-20

MaximumValue:20Unit:dB

mix/aux/<index>/eq/highshelf/bw


mix/aux/<index>/eq/highshelf/mode


mix/aux/<index>/eq/mid1/enable


mix/aux/<index>/eq/mid1/freq


mix/aux/<index>/eq/mid1/gain


mix/aux/<index>/eq/mid1/bw


mix/aux/<index>/eq/mid2/enable


mix/aux/<index>/eq/mid2/freq


mix/aux/<index>/eq/mid2/gain


mix/aux/<index>/eq/mid2/bw


mix/aux/<index>/eq/lowshelf/enable


mix/aux/<index>/eq/lowshelf/freq


mix/aux/<index>/eq/lowshelf/gain


mix/aux/<index>/eq/lowshelf/bw

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0.01

MaximumValue:3Unit:octaves

mix/aux/<index>/eq/lowshelf/mode


mix/aux/<index>/matrix/enable


mix/aux/<index>/matrix/prefader


mix/aux/<index>/matrix/panner


mix/aux/<index>/matrix/mute


mix/aux/<index>/matrix/fader


mix/group/<index>/matrix/aux/<index>/send


mix/group/<index>/matrix/reverb/<index>/send

Type:realPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0

MaximumValue:4Unit:linear

mix/group/<index>/eq/highshelf/enable


mix/group/<index>/eq/highshelf/freq


mix/group/<index>/eq/highshelf/gain


mix/group/<index>/eq/highshelf/bw


mix/group/<index>/eq/highshelf/mode


mix/group/<index>/eq/mid1/enable


mix/group/<index>/eq/mid1/freq


mix/group/<index>/eq/mid1/gain


mix/group/<index>/eq/mid1/bw


mix/group/<index>/eq/mid2/enable


mix/group/<index>/eq/mid2/freq


mix/group/<index>/eq/mid2/gain


mix/group/<index>/eq/mid2/bw


mix/group/<index>/eq/lowshelf/enable


mix/group/<index>/eq/lowshelf/freq


mix/group/<index>/eq/lowshelf/gain


mix/group/<index>/eq/lowshelf/bw


mix/group/<index>/eq/lowshelf/mode


mix/group/<index>/leveler/enable


mix/group/<index>/leveler/makeup


mix/group/<index>/leveler/reduction


mix/group/<index>/leveler/limit


mix/group/<index>/matrix/enable


mix/group/<index>/matrix/solo


mix/group/<index>/matrix/prefader


mix/group/<index>/matrix/panner


mix/group/<index>/matrix/mute


mix/group/<index>/matrix/fader


mix/reverb/<index>/matrix/aux/<index>/send


mix/reverb/<index>/matrix/reverb/<index>/send

Type:real

Permission:rwAvailablesincemixerversion:1.0.0MinimumValue:0MaximumValue:4Unit:linear

mix/reverb/<index>/eq/highshelf/enable


mix/reverb/<index>/eq/highshelf/freq


mix/reverb/<index>/eq/highshelf/gain


mix/reverb/<index>/eq/highshelf/bw


mix/reverb/<index>/eq/highshelf/mode


mix/reverb/<index>/eq/mid1/enable


mix/reverb/<index>/eq/mid1/freq

Type:intPermission:rwAvailablesincemixerversion:1.0.0

MinimumValue:20MaximumValue:20000Unit:Hz

mix/reverb/<index>/eq/mid1/gain


mix/reverb/<index>/eq/mid1/bw


mix/reverb/<index>/eq/mid2/enable


mix/reverb/<index>/eq/mid2/freq


mix/reverb/<index>/eq/mid2/gain


mix/reverb/<index>/eq/mid2/bw


mix/reverb/<index>/eq/lowshelf/enable


mix/reverb/<index>/eq/lowshelf/freq


mix/reverb/<index>/eq/lowshelf/gain


mix/reverb/<index>/eq/lowshelf/bw


mix/reverb/<index>/eq/lowshelf/mode


mix/reverb/<index>/leveler/enable


mix/reverb/<index>/leveler/makeup


mix/reverb/<index>/leveler/reduction

Type:realPermission:rw

Availablesincemixerversion:1.0.0MinimumValue:0MaximumValue:100Unit:%

mix/reverb/<index>/leveler/limit


mix/reverb/<index>/matrix/enable


mix/reverb/<index>/matrix/solo


mix/reverb/<index>/matrix/prefader


mix/reverb/<index>/matrix/panner


mix/reverb/<index>/matrix/mute


mix/reverb/<index>/matrix/fader


mix/reverb/<index>/reverb/enable


mix/reverb/<index>/reverb/reverbtime

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:100MaximumValue:60000Unit:ms

mix/reverb/<index>/reverb/hf


mix/reverb/<index>/reverb/mf


mix/reverb/<index>/reverb/predelay

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:0MaximumValue:500Unit:ms

mix/reverb/<index>/reverb/mfratio

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:1MaximumValue:100Unit:%

mix/reverb/<index>/reverb/hfratio


mix/reverb/<index>/reverb/tailspread

Type:intPermission:rwAvailablesincemixerversion:1.0.0

MinimumValue:-100MaximumValue:100Unit:%

mix/reverb/<index>/reverb/mod


mix/monitor/<index>/matrix/enable


mix/monitor/<index>/matrix/mute


mix/monitor/<index>/matrix/fader


mix/monitor/<index>/assign

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-2MaximumValue:4096

mix/monitor/<index>/override

Type:intPermission:rwAvailablesincemixerversion:1.0.0MinimumValue:-1MaximumValue:4096

mix/monitor/<index>/auto


MOTU AVB Datastore API The Datastore JSON over HTTP Interface AVB Web API.pdf · The resulting JSON...

Documents

Transcript of MOTU AVB Datastore API The Datastore JSON over HTTP Interface AVB Web API.pdf · The resulting JSON...