Header_Audio_APIHeader_Audio_API

Develop apps to control Sony's latest home audio devices

How does Sony’s Audio Control API software architecture work?

Sony’s Audio Control API is an HTTP service that is always running on the audio product, and your application accesses these services as a client, through the Audio Control API. The API accepts JSON-RPC messages and can be called via an HTTP POST method or sent via a WebSocket connection. The service is divided into three sub parts; audio, system and avContent.

API serviceDescription
API service
/audio
Description
This service handles APIs that are related to audio functions like volume and sound effects.
API service
/system
Description
This service handles APIs that are related to basic device functions.
API service
/avcontent
Description
This service handles APIs that are related to the overall audio-video control of the device, including control of the inputs and outputs.

How does versioning work with the Audio Control API?

The Audio Control API includes versioning on two levels. The Audio Control API itself has a version, and additionally, each available API within the Audio Control API also has a version.

Audio Control API version

The Audio Control API has its version defined by its specifying functions. The version is incremented when an API is added or deleted, or a supporting function in an APIs is changed.

API versions within the Audio Control API

Each API available in the Audio Control API also has a version. This version is represented as two numbers separated by a period (.), for example, X.Y. The version for each API begins at version “1.0”.

Your client application MUST set the “version” parameter in the request, to specify which version of the given API to use. For version information for each API, please see the API references.

Can these devices work in a multi-zone environment?

All the Sony audio devices have multiple sound sources for multi-zone environments. These include:

  • External sources, such as HDMI or analog inputs.
  • Internal sources, such as the FM Tuner and USB.
  • Remote sources, such as DLNA, Phones, Google Cast, Spotify, AirPlay, or Bluetooth.

The Sony DN1080 and some other receivers also have multiple outputs, each of which is called an output zone. The DN1080 has 3 possible zones: MainZone, Zone2, and HDMI Zone. In the Audio Control API a zone is usually identified by a number. Such as zone=1 for the MainZone, zone=2 for Zone2, and so on.

The MainZone is the primary speaker output. All source components are in it, and it provides multichannel sound.

Additional zones can be used to play music in other rooms, independent of what is playing in the MainZone or other zones. Extra zones can have some limitations. On the DN1080, for example, Zone2 provides line-level stereo audio output for use with a separate power amplifier and the HDMIZone allows for watching video content from different sources in two zones simultaneously.  For more information, see the instruction manual of the receiver.