bosesoundtouchapi.models.zonemember

@export
class ZoneMember:

SoundTouch device ZoneMember configuration object.

This class contains the attributes and sub-items that represent a single multiroom zone member configuration of the device.

ZoneMember( ipAddress: str = None, deviceId: str = None, deviceRole: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • ipAddress (str): Zone member device IPV4 address.
  • deviceId (str): Zone member device identifier.
  • deviceRole (str): The role of the zone member device (optional).
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
DeviceId: str

Zone member device identifier.

The master SoundTouch device cannot find zone members without their device id.

DeviceRole: str

The role of the zone member device (optional).

IpAddress: str

Zone member device IPV4 address.

def ToElement(self, isRequestBody: bool = False) -> xml.etree.ElementTree.Element:

Returns an xmltree Element node representation of the class.

Arguments:
  • isRequestBody (bool): True if the element should only return attributes needed for a POST request body; otherwise, False to return all attributes.
def ToString(self) -> str:

Returns a displayable string representation of the class.

def ToXmlString(self, encoding: str = 'utf-8') -> str:

Returns an xml string representation of the class.

Arguments:
  • encoding (str): encode type (e.g. 'utf-8', 'unicode', etc).
    Default is 'utf-8'.