Release Notes Version 18.1

Latest information on the Spectera API, including detailed descriptions of new features, breaking changes, upcoming deprecations and known issues.

Version 18.1.0

New Features

  • Command Mode: New API endpoints and properties for controlling the routing and behavior of Mobile Devices and Audio I/O for command mode. See the OpenAPI specification and description for details.
  • Level Recording (Preliminary): New API endpoints for recording and retrieving audio levels of Mobile Devices and Audio I/O, including a new schema definition for the level recording data structure. See the OpenAPI specification and description for details.

Improvements

  • Mobile Devices: New property swUpdateNotPossibleReason for paired devices to provide more information on why a software update is not possible for a specific device. See the OpenAPI specification and description for details.
  • Mobile Devices + RF (Custom LED Colors): With the new connectedStateColor property for paired devices /api/mts/paired/all/{mtUid} and ledColors for RF antenna configuration /api/rf/antennas it is now possible to set custom LED colors for the device. This will replace the previous ledBrightness property.
  • Device: It's now possible to retrieve the current system time with the endpoint /api/device/time which can be used for better synchronization of client applications with the Spectera system e.g. for Level Recording timestamps.

Breaking Changes

  • Mobile Devices: The deprecated connected property for paired devices has been removed now - Use the state property with values "Connected" and "Disconnected" instead
  • Mobile Devices (Command Mode): The old preliminary Command Mode feature has been changed slightly which leads to some breaking changes for the properties commandBehavior and commandState for paired devices at /api/mts/paired/all/{mtUid}.
  • Audio IO (Command Mode): The properties commandModeAudioNetwork, commandModeMadi1 and commandModeMadi2 for Audio Outputs /api/audio/outputs/{outputId} can not be used for controlling the command mode behavior anymore.
    • Although the command mode was already introduced in version 17.0 as preliminary feature, the properties mentioned above will be deprecated and behave differently already now. The existing values are mapped to the new *EnableIfCommandIsDisabled properties only. The values Mute and Talk are converted to On to prevent unintentional audio muting. To activate the Mute and Talk command behavior the new *EnableIfCommandIsEnabled properties must be used.

Upcoming Deprecations

These functionalities are still available in this version but will be removed in the next major version. Please update your implementation to use the new alternatives as soon as possible to avoid disruptions when upgrading to the next major version.

  • Audio Interfaces + Audio IO: As preparation for upcoming new audio interface the name of the interface Dante and AudioNetwork will be replaced with the more generic name AoIP (Audio over IP). The following endpoints and properties will be replaced by adding new and removing the old ones. The old endpoints and properties are marked as deprecated until they are removed with the next major version:
    • Audio Interfaces: Endpoints /api/audio/interface/audionetwork/status and /api/audio/interface/audionetwork/clock/input/status will be replaced by /api/audio/interface/aoip/status and /api/audio/interface/aoip/clock/input/status
    • Audio Interfaces: The outputStatus/clockSource property for the following endpoints will be replaced by outputStatus/outputClockSource
      • /api/audio/interface/madi1/status
      • /api/audio/interface/madi2/status
      • /api/audio/interface/wordclock/status
    • Audio Interfaces: The clockSource property for the following endpoints will be replaced by outputClockSource
      • /api/audio/interface/madi1/output
      • /api/audio/interface/madi2/output
      • /api/audio/interface/wordclock/output
    • Audio IO: Endpoint /api/audio/levels will be replaced by /api/audio/metering while the internal properties danteIn and danteOut will be replaced by aoIpIn and aoIpOut respectively.
    • Audio IO: The source property for audio inputs /api/audio/inputs/{inputId} will be replaced by inputSource
    • Audio IO: At the audio outputs /api/audio/outputs/{outputId} the following properties will be replaced by adding new and deprecating the old ones:
      • commandModeAudioNetwork will be replaced by aoIpEnableIfCommandIsDisabled and aoIpEnableIfCommandIsEnabled
      • commandModeMadi1 will be replaced by madi1EnableIfCommandIsDisabled and madi1EnableIfCommandIsEnabled
      • commandModeMadi2 will be replaced by madi2EnableIfCommandIsDisabled and madi2EnableIfCommandIsEnabled
    • Firmware Update: The danteVersion property will be replaced by aoIpVersion in the firmware update status endpoint /api/firmware/update/state
  • Mobile Devices + RF: The ledBrightness property for paired devices at /api/mts/paired/all/{mtUid} and RF antenna configuration at /api/rf/antennas will be replaced. Please use the new connectedStateColor property for paired devices and ledColors for RF antenna configuration to set custom LED colors for the device.
  • SSC: The endpoint /api/ssc/heartbeatis going to be removed with the next major version of the API. Use /api/device/time instead.

Preliminary Features

These functionalities are not fully implemented yet and the behavior may change in future versions of the API even without deprecation announcements.

  • Mobile Devices: (Sleep Mode) sleep property for paired devices /api/mts/paired/all/{mtUid}
  • Level Recording: All endpoints and especially the schema definition for the level recording data structure are still subject to change.

Known Issues

  • RF: Although the property bandwidthMode at /api/rf/channels/{rfChannelId} can be set to the value 10000 (10 MHz) the system will never enable the RF transmission, since it is not certified yet for operation with 10 MHz bandwidth and all license entitlements will block the usage. Please choose a different bandwidth allowed with your license entitlement. Current RF restrictions can be read at /api/rf/restrictions.
  • Mobile Devices + Audio IO: There is no dedicated audio mute per Mobile Device nor per Audio I/O available yet. We assume that the audio muting will be done outside the Spectera system e.g. on a mixing console.