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
swUpdateNotPossibleReasonfor 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
connectedStateColorproperty for paired devices/api/mts/paired/all/{mtUid}andledColorsfor RF antenna configuration/api/rf/antennasit is now possible to set custom LED colors for the device. This will replace the previousledBrightnessproperty. - Device: It's now possible to retrieve the current system time with the endpoint
/api/device/timewhich 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
connectedproperty for paired devices has been removed now - Use thestateproperty 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
commandBehaviorandcommandStatefor paired devices at/api/mts/paired/all/{mtUid}. - Audio IO (Command Mode): The properties
commandModeAudioNetwork,commandModeMadi1andcommandModeMadi2for 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
*EnableIfCommandIsDisabledproperties only. The valuesMuteandTalkare converted toOnto prevent unintentional audio muting. To activate theMuteandTalkcommand behavior the new*EnableIfCommandIsEnabledproperties must be used.
- 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
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
DanteandAudioNetworkwill be replaced with the more generic nameAoIP(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/statusand/api/audio/interface/audionetwork/clock/input/statuswill be replaced by/api/audio/interface/aoip/statusand/api/audio/interface/aoip/clock/input/status - Audio Interfaces: The
outputStatus/clockSourceproperty for the following endpoints will be replaced byoutputStatus/outputClockSource/api/audio/interface/madi1/status/api/audio/interface/madi2/status/api/audio/interface/wordclock/status
- Audio Interfaces: The
clockSourceproperty for the following endpoints will be replaced byoutputClockSource/api/audio/interface/madi1/output/api/audio/interface/madi2/output/api/audio/interface/wordclock/output
- Audio IO: Endpoint
/api/audio/levelswill be replaced by/api/audio/meteringwhile the internal propertiesdanteInanddanteOutwill be replaced byaoIpInandaoIpOutrespectively. - Audio IO: The
sourceproperty for audio inputs/api/audio/inputs/{inputId}will be replaced byinputSource - Audio IO: At the audio outputs
/api/audio/outputs/{outputId}the following properties will be replaced by adding new and deprecating the old ones:commandModeAudioNetworkwill be replaced byaoIpEnableIfCommandIsDisabledandaoIpEnableIfCommandIsEnabledcommandModeMadi1will be replaced bymadi1EnableIfCommandIsDisabledandmadi1EnableIfCommandIsEnabledcommandModeMadi2will be replaced bymadi2EnableIfCommandIsDisabledandmadi2EnableIfCommandIsEnabled
- Firmware Update: The
danteVersionproperty will be replaced byaoIpVersionin the firmware update status endpoint/api/firmware/update/state
- Audio Interfaces: Endpoints
- Mobile Devices + RF: The
ledBrightnessproperty for paired devices at/api/mts/paired/all/{mtUid}and RF antenna configuration at/api/rf/antennaswill be replaced. Please use the newconnectedStateColorproperty for paired devices andledColorsfor 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/timeinstead.
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)
sleepproperty 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
bandwidthModeat/api/rf/channels/{rfChannelId}can be set to the value10000(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.
