bosesoundtouchapi.models.balance

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

SoundTouch device Balance configuration object.

This class contains the attributes and sub-items that represent the balance configuration of the device.

Balance(target: int = 0, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • target (int): Target balance level to set.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Actual: int

Actual value of the balance level.

Default: int

Default value of the balance level.

DeviceId: str

Device identifier the configuration information was obtained from.

IsAvailable: bool

True, if a balance confiiguration can be altered; otherwise, False.

Maximum: int

Maximum allowed value of the balance level.

Minimum: int

Minimum allowed value of the balance level.

Target: int

Targeted value of the balance level.

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.