bosesoundtouchapi.models.audiodspcontrols

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

SoundTouch device AudioDspControls configuration object.

This class contains the attributes and sub-items that represent the Audio DSP Controls configuration of the device.

AudioDspControls( audioMode: bosesoundtouchapi.models.audiodspaudiomodes.AudioDspAudioModes = None, videoSyncAudioDelay: int = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • audioMode (AudioDspAudioModes|str): Audio mode value (e.g. "AUDIO_MODE_NORMAL", "AUDIO_MODE_DIALOG", etc).
  • videoSyncAudioDelay (int): Video syncronization audio delay value.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Raises:
  • SoundTouchError: videoSyncAudioDelay argument was not of type int.
AudioMode: str

Audio mode value (e.g. "AUDIO_MODE_NORMAL", "AUDIO_MODE_DIALOG", etc).

SupportedAudioModes: str

Supported audio modes (e.g. "AUDIO_MODE_NORMAL|AUDIO_MODE_DIALOG", etc).

VideoSyncAudioDelay: int

Video syncronization audio delay value.

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.

def ToSupportedAudioModesArray(self) -> list[str]:

Returns a string array of SupportedAudioModes.

An empty list object is returned if the SupportedAudioModes property is None or empty; otherwise, a list of the supported audio modes is returned.

def ToSupportedAudioModeTitlesArray(self) -> list[str]:

Returns a string array of titles for SupportedAudioModes.