.. THIS FILE WAS GENERATED - DO NOT MODIFY
.. _net-api_netRemote_multiroom:

===================
netRemote.multiroom
===================


BaseMultiroomCapsMaxClients (netRemote.multiroom.caps.maxClients)
-----------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.caps.maxClients``
      - ``GET``
      - :class:`NodeU8`
      -  ``False``, ``True``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.caps.maxClients?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomCapsProtocolVersion (netRemote.multiroom.caps.protocolVersion)
---------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.caps.protocolVersion``
      - ``GET``
      - :class:`NodeU32`
      -  ``False``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.caps.protocolVersion?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientMute0 (netRemote.multiroom.client.mute0)
-----------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.mute0``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NOT_MUTE"*
- ``1``: *"MUTE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.mute0?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientMute1 (netRemote.multiroom.client.mute1)
-----------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.mute1``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NOT_MUTE"*
- ``1``: *"MUTE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.mute1?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientMute2 (netRemote.multiroom.client.mute2)
-----------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.mute2``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NOT_MUTE"*
- ``1``: *"MUTE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.mute2?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientMute3 (netRemote.multiroom.client.mute3)
-----------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.mute3``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NOT_MUTE"*
- ``1``: *"MUTE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.mute3?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientStatus0 (netRemote.multiroom.client.status0)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.status0``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"CONNECTED"*
- ``1``: *"SYNCRONIZING"*
- ``2``: *"READY_TO_STREAM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.status0?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientStatus1 (netRemote.multiroom.client.status1)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.status1``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"CONNECTED"*
- ``1``: *"SYNCRONIZING"*
- ``2``: *"READY_TO_STREAM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.status1?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientStatus2 (netRemote.multiroom.client.status2)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.status2``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"CONNECTED"*
- ``1``: *"SYNCRONIZING"*
- ``2``: *"READY_TO_STREAM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.status2?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientStatus3 (netRemote.multiroom.client.status3)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.status3``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"CONNECTED"*
- ``1``: *"SYNCRONIZING"*
- ``2``: *"READY_TO_STREAM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.status3?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientVolume0 (netRemote.multiroom.client.volume0)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.volume0``
      - ``GET``, ``SET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.volume0?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientVolume1 (netRemote.multiroom.client.volume1)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.volume1``
      - ``GET``, ``SET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.volume1?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientVolume2 (netRemote.multiroom.client.volume2)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.volume2``
      - ``GET``, ``SET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.volume2?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomClientVolume3 (netRemote.multiroom.client.volume3)
---------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.client.volume3``
      - ``GET``, ``SET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.client.volume3?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomDeviceClientIndex (netRemote.multiroom.device.clientIndex)
-----------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.clientIndex``
      - ``GET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.device.clientIndex?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomDeviceClientStatus (netRemote.multiroom.device.clientStatus)
-------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.clientStatus``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"CONNECTED"*
- ``1``: *"SYNCRONIZING"*
- ``2``: *"READY_TO_STREAM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.device.clientStatus?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


Multiroom: List Devices (netRemote.multiroom.device.listAll)
------------------------------------------------------------

Lists all other multiroom devices in the local network.

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.listAll``
      - ``LIST_GET_NEXT``
      - :class:`NodeList`
      -  ``False``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/LIST_GET_NEXT/netRemote.multiroom.device.listAll/-1?pin=1234

    <fsapiresponse>
        <item key="0">
            <field name="udn">
                <c8_array>46C19E4A-472B-11E1-9F67-002261ED0770</c8_array>
            </field>
            <field name="friendlyname">
                <c8_array>DeviceName</c8_array>
            </field>
            <field name="ipaddress">
                <c8_array>192.168.xxx.xxx</c8_array>
            </field>
            <field name="audiosyncversion">
                <c8_array>3</c8_array>
            </field>
            <field name="groupid">
                <c8_array>0AD57A8A-49A8-11E6-XXXX-002261EDXXXX</c8_array>
            </field>
            <field name="groupname">
                <c8_array>MultirooGroupName</c8_array>
            </field>
            <field name="grouprole">
                <u8>2</u8>
            </field>
            <field name="clientnumber">
                <u8>254</u8>
            </field>
        </item>
        <listend/>
    </fsapiresponse>

.. raw:: html

    <hr>


BaseMultiroomDeviceListAllVersion (netRemote.multiroom.device.listAllVersion)
-----------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.listAllVersion``
      - ``GET``
      - :class:`NodeU32`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.device.listAllVersion?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomDeviceServerStatus (netRemote.multiroom.device.serverStatus)
-------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.serverStatus``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"STREAM_STARTING"*
- ``1``: *"STREAM_PRESENTABLE"*
- ``2``: *"STREAM_UNPRESENTABLE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.device.serverStatus?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomDeviceTransportOptimisation (netRemote.multiroom.device.transportOptimisation)
-------------------------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.device.transportOptimisation``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``False``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"DISABLED"*
- ``1``: *"ENABLED"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.device.transportOptimisation?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupAddClient (netRemote.multiroom.group.addClient)
-----------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.addClient``
      - ``GET``, ``SET``
      - :class:`NodeC8`
      -  ``False``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.addClient?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupAttachedClients (netRemote.multiroom.group.attachedClients)
-----------------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.attachedClients``
      - ``GET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.attachedClients?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupBecomeServer (netRemote.multiroom.group.becomeServer)
-----------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.becomeServer``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NO_GROUP"*
- ``1``: *"CLIENT"*
- ``2``: *"SERVER"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.becomeServer?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupCreate (netRemote.multiroom.group.create)
-----------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.create``
      - ``GET``, ``SET``
      - :class:`NodeC8`
      -  ``False``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.create?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupDestroy (netRemote.multiroom.group.destroy)
-------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.destroy``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``False``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"IDLE"*
- ``1``: *"DESTROY"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.destroy?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupId (netRemote.multiroom.group.id)
---------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.id``
      - ``GET``
      - :class:`NodeC8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.id?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupMasterVolume (netRemote.multiroom.group.masterVolume)
-----------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.masterVolume``
      - ``GET``, ``SET``
      - :class:`NodeU8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.masterVolume?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupName (netRemote.multiroom.group.name)
-------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.name``
      - ``GET``
      - :class:`NodeC8`
      -  ``True``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.name?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupRemoveClient (netRemote.multiroom.group.removeClient)
-----------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.removeClient``
      - ``GET``, ``SET``
      - :class:`NodeC8`
      -  ``False``, ``False``


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.removeClient?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupState (netRemote.multiroom.group.state)
---------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.state``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"NO_GROUP"*
- ``1``: *"CLIENT"*
- ``2``: *"SERVER"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.state?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomGroupStreamable (netRemote.multiroom.group.streamable)
-------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.group.streamable``
      - ``GET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"FALSE"*
- ``1``: *"TRUE"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.group.streamable?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>


BaseMultiroomSinglegroupState (netRemote.multiroom.singlegroup.state)
---------------------------------------------------------------------

*TODO*

.. list-table::
    :header-rows: 1
    :widths: 20, 20, 20, 20

    * - Node Path
      - Methods
      - Type
      - Notifying, Cacheable
    * - ``netRemote.multiroom.singlegroup.state``
      - ``GET``, ``SET``
      - :class:`NodeE8`
      -  ``True``, ``False``


As this node is of an enum type, you can utilize the following constants in
its usage:

- ``0``: *"SINGLE"*
- ``1``: *"MULTIROOM"*


.. code-block:: xml
    :linenos:
    :caption: Example: /fsapi/GET/netRemote.multiroom.singlegroup.state?pin=1234

    <!-- TBD --!>

.. raw:: html

    <hr>