bosesoundtouchapi.models.speakerattributeandsetting

@export
class SpeakerAttributeAndSetting(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device Speaker Attribute and Setting configuration object.

This class contains the attributes and sub-items that represent a speaker attribute and setting configuration for the device.

SpeakerAttributeAndSetting(controlType: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • controlType (str): Type of control the values represent (e.g. "rear", "subwoofer01", "subwoofer02", etc).
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Raises:
  • SoundTouchError: controlType argument was not of type str or was not supplied.
Active: bool

True if the speaker is active; otherwise, false.

Available: bool

True if the speaker is available; otherwise, false.

Controllable: bool

True if the speaker is controllable; otherwise, false.

ControlType: str

Type of control the values represent (e.g. "rear", "subwoofer01", "subwoofer02", etc).

IsAnyPropertySet: bool

True if any property besides ControlType is set in this object; otherwise, false.

Wireless: bool

True if the speaker is wireless; otherwise, false.

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

Overridden.
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.