bosesoundtouchapi.models.grouprole

@export
class GroupRole:

SoundTouch device GroupRole configuration object.

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

GroupRole( ipAddress: str = None, deviceId: str = None, role: bosesoundtouchapi.models.grouproletypes.GroupRoleTypes = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • deviceId (str): Unique identifier of the device.
  • ipAddress (str): IPV4 address of the device.
  • role (GroupRoleTypes|str): Role (or location) of the device ("LEFT", "RIGHT").
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
DeviceId: str

Unique identifier of the device.

IpAddress: str

IPV4 address of the device.

Role: str

Role (or location) of the device ("LEFT", "RIGHT", "NORMAL").

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.