bosesoundtouchapi.models.capabilities

@export
class Capabilities:

SoundTouch device Capabilities configuration object.

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

This class contains important configuration values, such as IsWebSocketApiProxyCapable which indicates whether the WebSocket notification API can be used.

Next, a capabilities object shows whether a clock display is available or if the device can run in dual Mode. Each device comes with different additional features, which are also stored in this class with a dict-like implementation with the following mapping: self[cap.name] = cap.url.

Capabilities(root: xml.etree.ElementTree.Element)

Initializes a new instance of the class.

Arguments:
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
DeviceId: str

Device identifier the configuration information was obtained from.

IsAudioDspControlsCapable: bool

Returns whether the device supports audiodspcontrols functionality.

IsAudioProductLevelControlsCapable: bool

Returns whether the device supports audioproductlevelcontrols functionality.

IsAudioProductToneControlsCapable: bool

Returns whether the device supports audioproducttonecontrols functionality.

IsAudioSpeakerAttributeAndSettingCapable: bool

Returns whether the device supports audiospeakerattributeandsetting functionality.

IsBcoResetCapable: bool

Returns whether the device contains a Bose coreset.

IsClockDisplayCapable: bool

Returns whether the clock display is available.

IsDisablePowerSavingCapable: bool

Returns whether the power saving mode can be disabled.

IsDualModeCapable: bool

Returns whether the device can run in dual mode.

IsLightSwitchCapable: bool

Returns whether the light switch can be used.

IsLrStereoCapable: bool

Returns whether the device is left-right stereo capable.

IsProductCecHdmiControlCapable: bool

Returns whether the device supports productcechdmicontrol functionality.

IsProductHdmiAssignmentControlsCapable: bool

Returns whether the device supports producthdmiassignmentcontrols functionality.

IsReBroadcastLatencyModeCapable: bool

Returns whether the device supports rebroadcastlatencymode functionality.

IsSystemTimeoutCapable: bool

Returns whether the device supports systemtimeout functionality.

IsSystemTimeoutControlCapable: bool

Returns whether the device supports systemtimeoutcontrol functionality.

IsWebSocketApiProxyCapable: bool

Returns whether the WebSocket API can be used on port 8080.

def ToString(self, includeItems: bool = False) -> str:

Returns a displayable string representation of the class.

Arguments:
  • includeItems (bool): True to include all items in the list; otherwise False to only include the base list.