bosesoundtouchapi.soundtouchnotifycategorys

@export
class SoundTouchNotifyCategorys(enum.Enum):

This class contains all event type categories that are generated by the SoundTouch device event notification system when an event is processed.

These constants can be used when adding and removing event listeners in the bosesoundtouchapi.ws.soundtouchwebsocket.SoundTouchWebSocket class.

audiodspcontrols = <SoundTouchNotifyCategorys.audiodspcontrols: 'audiodspcontrols'>

Occurs when audio dsp control values (e.g. AudioMode, etc) have changed.

audioproductlevelcontrols = <SoundTouchNotifyCategorys.audioproductlevelcontrols: 'audioproductlevelcontrols'>

Occurs when audio product level control values (e.g. FrontCenterSpeakerLevel, RearSurroundSpeakersLevel, etc) have changed.

audioproducttonecontrols = <SoundTouchNotifyCategorys.audioproducttonecontrols: 'audioproducttonecontrols'>

Occurs when audio product tone control values (e.g. Bass, Treble, etc) have changed.

connectionStateUpdated = <SoundTouchNotifyCategorys.connectionStateUpdated: 'connectionStateUpdated'>

Occurs when a network connection state has changed. This normally happens when the device senses a wifi signal change (e.g. signal strength goes from poor to excellent, etc).

criticalErrorUpdate = <SoundTouchNotifyCategorys.criticalErrorUpdate: 'criticalErrorUpdate'>
errorNotification = <SoundTouchNotifyCategorys.errorNotification: 'errorNotification'>
errorUpdate = <SoundTouchNotifyCategorys.errorUpdate: 'errorUpdate'>
groupUpdated = <SoundTouchNotifyCategorys.groupUpdated: 'groupUpdated'>

Occurs when a group has been modified (created, member added, member removed, etc) on the device.

infoUpdated = <SoundTouchNotifyCategorys.infoUpdated: 'infoUpdated'>
languageUpdated = <SoundTouchNotifyCategorys.languageUpdated: 'languageUpdated'>
LowPowerStandbyUpdate = <SoundTouchNotifyCategorys.LowPowerStandbyUpdate: 'LowPowerStandbyUpdate'>
nameUpdated = <SoundTouchNotifyCategorys.nameUpdated: 'nameUpdated'>

Occurs when the device name has been updated.

nowPlayingUpdated = <SoundTouchNotifyCategorys.nowPlayingUpdated: 'nowPlayingUpdated'>

Occurs when the currently playing media source has changed. Some examples of this event are:

  • when listening to a radio station / airplay / bluetooth, and the next song comes on.
  • when the device is powered down into STANDBY state.
nowSelectionUpdated = <SoundTouchNotifyCategorys.nowSelectionUpdated: 'nowSelectionUpdated'>

Occurs when the source selection has changed (e.g. switch from AirPlay to BlueTooth), as well as when the device is powered on / off.

presetsUpdated = <SoundTouchNotifyCategorys.presetsUpdated: 'presetsUpdated'>

Occurs when a preset has been updated, added, or removed from the device.

productcechdmicontrol = <SoundTouchNotifyCategorys.productcechdmicontrol: 'productcechdmicontrol'>

Occurs when the HDMI CEC Mode is changed.

recentsUpdated = <SoundTouchNotifyCategorys.recentsUpdated: 'recentsUpdated'>

Occurs when a recently played item has been updated, added, or removed from the device.

soundTouchConfigurationUpdated = <SoundTouchNotifyCategorys.soundTouchConfigurationUpdated: 'soundTouchConfigurationUpdated'>
SoundTouchSdkInfo = <SoundTouchNotifyCategorys.SoundTouchSdkInfo: 'SoundTouchSdkInfo'>

Server version and build information. It occurs when the initial connection to the SoundTouch device notification server is made.

sourcesUpdated = <SoundTouchNotifyCategorys.sourcesUpdated: 'sourcesUpdated'>

Occurs when the sources list has been updated - e.g. if a source is added, or deleted.

swUpdateStatusUpdated = <SoundTouchNotifyCategorys.swUpdateStatusUpdated: 'swUpdateStatusUpdated'>
userActivityUpdate = <SoundTouchNotifyCategorys.userActivityUpdate: 'userActivityUpdate'>

Occurs when a user has manually sent the device a request; some examples of this are:

  • a button is pressed on the devices' physical remote control.
  • the volume down / up button was pressed on the physical device.
volumeUpdated = <SoundTouchNotifyCategorys.volumeUpdated: 'volumeUpdated'>

Occurs when the device volume level has been changed.

WebSocketClose = <SoundTouchNotifyCategorys.WebSocketClose: 'WebSocketClose'>

Occurs when a websocket close is encountered (e.g. connection closed). This will occur when a connection has been closed to the SoundTouch device via a websocket.

WebSocketError = <SoundTouchNotifyCategorys.WebSocketError: 'WebSocketError'>

Occurs when a websocket error is encountered (e.g. ConnectionResetError, etc). This can occur when the SoundTouch device is powered off after a connection was been made to it via a websocket.

WebSocketOpen = <SoundTouchNotifyCategorys.WebSocketOpen: 'WebSocketOpen'>

Occurs when a websocket open is encountered (e.g. connection established). This will occur when a connection has been made to the SoundTouch device via a websocket.

WebSocketPing = <SoundTouchNotifyCategorys.WebSocketPing: 'WebSocketPing'>

Occurs when a websocket ping is encountered. This will occur when the SoundTouch device websocket server sends us a ping request. Ping requests can be enabled / disabled when calling the run_forever() method.

WebSocketPong = <SoundTouchNotifyCategorys.WebSocketPong: 'WebSocketPong'>

Occurs when a websocket pong is encountered. This will occur when the SoundTouch device websocket server responds to a ping request. Ping requests can be enabled / disabled when calling the run_forever() method.

zoneUpdated = <SoundTouchNotifyCategorys.zoneUpdated: 'zoneUpdated'>

Occurs when a zone has been modified (created, member added, member removed, etc) on the device.

@staticmethod
def toString(category) -> str:

Returns the enum.value (instead of classname.value) as a string.