diff --git a/FSAPI.md b/FSAPI.md index 28acd2c..7b0e51c 100755 --- a/FSAPI.md +++ b/FSAPI.md @@ -240,7 +240,7 @@ Todo ### Multiroom -:exclamation: The following comands work only on devices with mutiroom-support :exclamation: +:exclamation: The following commands work only on devices with multiroom-support :exclamation: #### netRemote.multiroom.caps.maxClients @@ -277,7 +277,7 @@ Todo #### netRemote.multiroom.device.listAll Method: LIST_GET_NEXT -Shows other Mutiroom devices in the Network +Shows other Multiroom devices in the Network ``` /fsapi/LIST_GET_NEXT/netRemote.multiroom.device.listAll/-1?pin=1337&maxItems=10 @@ -288,25 +288,26 @@ Shows other Mutiroom devices in the Network 192.168.xxx.xxx 3 0AD57A8A-49A8-11E6-XXXX-002261EDXXXX -MultirooGroupName +MultiroomGroupName 2 254 - ``` #### netRemote.multiroom.device.listAllVersion TODO -Method: ?? +Method: GET_NOTIFIES -??? +Continuous numbering of status queries ``` +/fsapi/GET_NOTIFIES?pin=1337&sid=[session no.] +67 ``` @@ -323,7 +324,6 @@ Method: GET /fsapi/GET/netRemote.multiroom.device.serverStatus?pin=1337 1 - ``` #### netRemote.multiroom.device.clientStatus @@ -341,7 +341,6 @@ Method: GET /fsapi/GET/netRemote.multiroom.device.clientIndex?pin=1337 0 - ``` @@ -356,8 +355,7 @@ Method: GET ``` /fsapi/GET/netRemote.multiroom.device.transportOptimisation?pin=1337 -FS_NODE_DOES_NOT_EXIST - +FS_OK1 ``` @@ -396,44 +394,43 @@ Method: GET /fsapi/GET/netRemote.multiroom.group.streamable?pin=1337 1 - ``` #### netRemote.multiroom.group.create Method: SET -Create new group +Create new group. Further information can be requested via GET_NOTIFIES. See also the example at the end of the multi-room chapter. ``` /fsapi/SET/netRemote.multiroom.group.create?pin=1337&value=GroupName -FS_NODE_DOES_NOT_EXIST - +FS_OK ``` #### netRemote.multiroom.group.addClient Method: SET -Add device to group +Add device to group. Further information can be requested via GET_NOTIFIES. See also the example at the end of the multi-room chapter. ``` /fsapi/SET/netRemote.multiroom.group.addClient?pin=1337&value=[Device-udn] -FS_NODE_DOES_NOT_EXIST - +FS_OK ``` #### netRemote.multiroom.group.attachedClients TODO -Method: ?? +Method: GET_NOTIFIES -??? +Probably 1 during the AddClient process. ``` +/fsapi/GET_NOTIFIES?pin=1337&sid=[session no.] +0 ``` @@ -446,34 +443,29 @@ Delete Multiroom group /fsapi/SET/netRemote.multiroom.group.destroy?pin=1337&value=1 FS_NODE_DOES_NOT_EXIST - ``` #### netRemote.multiroom.group.name Method: GET -Get Mutiroom Group Name +Get Multiroom Group Name ``` /fsapi/GET/netRemote.multiroom.group.name?pin=1337 -1234 - +Group 1 ``` #### netRemote.multiroom.group.id -TODO - Method: GET -??? +Get GUID of the group ``` /fsapi/GET/netRemote.multiroom.group.id?pin=1337 501867A4-42A7-11E6-XXXX-002261E7XXXX - ``` #### netRemote.multiroom.group.state @@ -485,7 +477,6 @@ Method: GET, SET /fsapi/GET/netRemote.multiroom.group.state?pin=1337 2 - ``` @@ -498,7 +489,6 @@ Set/Get Volume for device No X (0,1,2,...) /fsapi/GET/netRemote.multiroom.client.volume0?pin=1337&value=12 20 - ``` #### netRemote.multiroom.client.muteX @@ -510,7 +500,6 @@ Set/Get MuteState for device No X (0,1,2,...) /fsapi/GET/netRemote.multiroom.client.mute?pin=1337&value=1 0 - ``` @@ -523,9 +512,138 @@ Set/Get Volume for all devices /fsapi/GET/netRemote.multiroom.group.masterVolume?pin=1337&value=12 12 +``` +#### Example of the command sequence for creating a multi-room group with the addition of a client. (Recording UNDOK). +Please note that some commands are repeated, probably due to delays between requests and responses. +Note also that the value 'multiroom.device.listallversion' is continuously incremented during status queries. ``` +GET/fsapi/SET/netRemote.multiroom.group.create?pin=1337&value=Group+1 + +FS_OK + + +# get notifies for the session +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK +64 + + + +GET/fsapi/GET/netRemote.multiroom.group.id?pin=1337 +FS_OKyyyyyyyy-BE17-11F0-8F8D-yyyyyyyyyyyy + + +# use the udn value of the client +GET/fsapi/SET/netRemote.multiroom.group.addClient?pin=1337&value=xxxxxxxx-472B-11E1-9F67-xxxxxxxxxxxx +FS_OK + + +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK +65 +1 +0 + + + +GET/fsapi/LIST_GET_NEXT/netRemote.multiroom.device.listAll/-1?pin=1337&maxItems=30 +FS_OK +xxxxxxxx-472B-11E1-9F67-xxxxxxxxxxxx +BLOCKA +192.168.178.43 +4 +yyyyyyyy-BE17-11F0-8F8D-yyyyyyyyyyyy +Group1 +1 +255 + + + +GET/fsapi/GET_MULTIPLE?pin=1337&node=netRemote.multiroom.group.name&node=netRemote.multiroom.group.id&node=netRemote.multiroom.group.state&node=netRemote.multiroom.device.serverStatus + + +netRemote.multiroom.group.nameFS_OKGroup1 +netRemote.multiroom.group.idFS_OKyyyyyyyy-BE17-11F0-8F8D-yyyyyyyyyyyy +netRemote.multiroom.group.stateFS_OK2 +netRemote.multiroom.device.serverStatusFS_OK1 + + + +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK +66 +1 +1 +3 +0 +0 + + + +GET/fsapi/LIST_GET_NEXT/netRemote.multiroom.device.listAll/-1?pin=1337&maxItems=30 + +FS_OK +xxxxxxxx-472B-11E1-9F67-xxxxxxxxxxxx +BLOCKA +192.168.178.43 +4 +yyyyyyyy-BE17-11F0-8F8D-yyyyyyyyyyyy +Group1 +1 +0 + + + +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK2 + + +GET/fsapi/GET_MULTIPLE?pin=1337&node=netRemote.multiroom.group.name&node=netRemote.multiroom.group.id&node=netRemote.multiroom.group.state&node=netRemote.multiroom.device.serverStatus + + +netRemote.multiroom.group.nameFS_OKGroup1 +netRemote.multiroom.group.idFS_OKyyyyyyyy-BE17-11F0-8F8D-yyyyyyyyyyyy +netRemote.multiroom.group.stateFS_OK2 +netRemote.multiroom.device.serverStatusFS_OK1 + + + +GET/fsapi/GET/netRemote.multiroom.client.status0?pin=1337 + +FS_OK1 + + +GET/fsapi/GET/netRemote.sys.info.friendlyName?pin=1337 + +FS_OKBLOCKCVR200 + + +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK +5 +4 + + + +GET/fsapi/GET_NOTIFIES?pin=1337&sid=1887203674 + +FS_OK +67 +0 + + + +GET/fsapi/GET/netRemote.multiroom.device.transportOptimisation?pin=1337 + +FS_OK1 +``` ### Misc #### netRemote.misc.fsDebug.component