bosesoundtouchapi.models.volume

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

SoundTouch device Volume configuration object.

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

Volume( actual: int = 0, target: int = 0, isMuted: bool = False, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • actual (int): The actual value of the volume level.
  • target (int): The targeted value of the volume level.
  • isMuted (bool): True if the device is muted; otherwise, False.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Actual: int

Actual value of the volume level.

DeviceId: str

Device identifier the configuration information was obtained from.

IsMuted: bool

True if the device is muted; otherwise, False.

Target: int

Targeted value of the volume 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.