Audio Control API
Develop apps to control Sony's latest home audio devices.
* The Audio Control API has now been archived. Developer World no longer offers updates and active support.
How can you use the device resource URI?
The device resource URI is used to access different sources on an audio product.
The URI can reference:
Physical input ports such as an HDMI port
Internal or remote services such as FM radio or a net service
Output sources such as a speaker zone
The following tables describe the sources defined in the Audio Control API and which audio products include support for the source. The Device resource URI column contains the device resource URI to use. In some cases, extra parameters have to be added. For example for the extInput:hdmi source, specify the port by adding ?port=X to the URI, where X is the port number, and for the extOutput:zone, specify the zone number by adding ?zone=Y to the URI, where Y is the zone number.
See the table below to get to know the available sound sources:
Soundbars
Scheme | Device Resource URI | Description | ST5000 | CT800 | MT500 | ZF9/Z9F | A9 | A7000 | A5000 |
|---|---|---|---|---|---|---|---|---|---|
Scheme extInput | Device Resource URI extInput:bd-dvd | Description BD/DVD input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme | Device Resource URI extInput:btAudio | Description Bluetooth Audio input resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme | Device Resource URI extInput:game | Description Game input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme | Device Resource URI extInput:hdmi | Description HDMI external input resource | ST5000 Yes | CT800 Yes | MT500 No | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme | Device Resource URI extInput:line | Description Audio line input resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 No | A7000 Yes | A5000 No |
Scheme | Device Resource URI extInput:sacd-cd | Description SACD/CD input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme | Device Resource URI extInput:sat-catv | Description SAT/CATV input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme | Device Resource URI extInput:source | Description Source input resource. This means that input resource is current main Zone input signal. | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme | Device Resource URI extInput:tv | Description TV input resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme | Device Resource URI extInput:video | Description Video input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme extOutput | Device Resource URI extOutput:zone | Description Zone external output resource. Users can enjoy playing audio in multiple rooms at the same time. This action is performed by connecting speakers in multiple locations, where the locations are identified by zone. | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
Scheme dlna | Device Resource URI dlna:music | Description DLNA music resource. (Use in limited methods) | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme storage | Device Resource URI storage:usb1 | Description USB1 storage for content. | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 No | A7000 Yes | A5000 Yes |
Scheme radio | Device Resource URI radio:fm | Description FM radio resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 No | A7000 No | A5000 No |
You cannot directly specify the following device resource URIs below; however, the Audio Control API service can automatically set them for certain services. These URIs can occur as a notification parameter.
Scheme | Device Resource URI | Description | ST5000 | CT800 | MT500 | ZF9/Z9F | A9 | A7000 | A5000 |
|---|---|---|---|---|---|---|---|---|---|
Scheme netService | Device Resource URI netService:audio | Description Audio Network service resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme multiroom | Device Resource URI multiroom:audio | Description Multiroom for Audio service resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 No | A7000 No | A5000 No |
Scheme cast | Device Resource URI cast:audio | Description Cast for Audio service resource | ST5000 Yes | CT800 Yes | MT500 Yes | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Scheme extInput | Device Resource URI extInput:airPlay | Description AirPlay input resource | ST5000 No | CT800 No | MT500 No | ZF9/Z9F No | A9 Yes | A7000 Yes | A5000 Yes |
Scheme alexa | Device Resource URI alexa:audio | Description Alexa | ST5000 No | CT800 No | MT500 No | ZF9/Z9F Yes | A9 Yes | A7000 Yes | A5000 Yes |
Receivers
Scheme | Device Resource URI | Description | DN1080 |
|---|---|---|---|
Scheme extInput | Device Resource URI extInput:bd-dvd | Description BD/DVD input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:btAudio | Description Bluetooth Audio input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:game | Description Game input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:hdmi | Description HDMI external input resource | DN1080 No |
Scheme | Device Resource URI extInput:line | Description Audio line input resource | DN1080 No |
Scheme | Device Resource URI extInput:sacd-cd | Description SACD/CD input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:sat-catv | Description SAT/CATV input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:source | Description Source input resource. This means that input resource is current main Zone input signal. | DN1080 Yes |
Scheme | Device Resource URI extInput:tv | Description TV input resource | DN1080 Yes |
Scheme | Device Resource URI extInput:video | Description Video input resource | DN1080 Yes |
Scheme extOutput | Device Resource URI extOutput:zone | Description Zone external output resource. Users can enjoy playing audio in multiple rooms at the same time. This action is performed by connecting speakers in multiple locations, where the locations are identified by zone. | DN1080 Yes |
Scheme dlna | Device Resource URI dlna:music | Description DLNA music resource. (Use in limited methods) | DN1080 Yes |
Scheme storage | Device Resource URI storage:usb1 | Description USB1 storage for content. | DN1080 Yes |
Scheme radio | Device Resource URI radio:fm | Description FM radio resource | DN1080 Yes |
You cannot directly specify the following device resource URIs below; however, the Audio Control API service can automatically set them for certain services. These URIs can occur as a notification parameter.
Scheme | Device Resource URI | Description | DN1080 |
|---|---|---|---|
Scheme netService | Device Resource URI netService:audio | Description Audio Network service resource | DN1080 Yes |
Scheme multiroom | Device Resource URI multiroom:audio | Description Multiroom for Audio service resource | DN1080 Yes |
Scheme cast | Device Resource URI cast:audio | Description Cast for Audio service resource | DN1080 Yes |
Scheme extInput | Device Resource URI extInput:airPlay | Description AirPlay input resource | DN1080 Yes |
Scheme alexa | Device Resource URI alexa:audio | Description Alexa | DN1080 No |
Speakers
Scheme | Device Resource URI | Description | ZR5 | RA3000 | RA5000 |
|---|---|---|---|---|---|
Scheme extInput | Device Resource URI extInput:bd-dvd | Description BD/DVD input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:btAudio | Description Bluetooth Audio input resource | ZR5 Yes | RA3000 Yes | RA5000 Yes |
Scheme | Device Resource URI extInput:game | Description Game input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:hdmi | Description HDMI external input resource | ZR5 Yes | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:line | Description Audio line input resource | ZR5 Yes | RA3000 Yes | RA5000 Yes |
Scheme | Device Resource URI extInput:sacd-cd | Description SACD/CD input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:sat-catv | Description SAT/CATV input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:source | Description Source input resource. This means that input resource is current main Zone input signal. | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:tv | Description TV input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme | Device Resource URI extInput:video | Description Video input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme extOutput | Device Resource URI extOutput:zone | Description Zone external output resource. Users can enjoy playing audio in multiple rooms at the same time. This action is performed by connecting speakers in multiple locations, where the locations are identified by zone. | ZR5 No | RA3000 No | RA5000 No |
Scheme dlna | Device Resource URI dlna:music | Description DLNA music resource. (Use in limited methods) | ZR5 Yes | RA3000 No | RA5000 No |
Scheme storage | Device Resource URI storage:usb1 | Description USB1 storage for content. | ZR5 Yes | RA3000 No | RA5000 No |
Scheme radio | Device Resource URI radio:fm | Description FM radio resource | ZR5 No | RA3000 No | RA5000 No |
You cannot directly specify the following device resource URIs below; however, the Audio Control API service can automatically set them for certain services. These URIs can occur as a notification parameter.
Scheme | Device Resource URI | Description | ZR5 | RA3000 | RA5000 |
|---|---|---|---|---|---|
Scheme netService | Device Resource URI netService:audio | Description Audio Network service resource | ZR5 Yes | RA3000 Yes | RA5000 Yes |
Scheme multiroom | Device Resource URI multiroom:audio | Description Multiroom for Audio service resource | ZR5 No | RA3000 No | RA5000 No |
Scheme cast | Device Resource URI cast:audio | Description Cast for Audio service resource | ZR5 Yes | RA3000 Yes | RA5000 Yes |
Scheme extInput | Device Resource URI extInput:airPlay | Description AirPlay input resource | ZR5 No | RA3000 No | RA5000 No |
Scheme alexa | Device Resource URI alexa:audio | Description Alexa | ZR5 No | RA3000 Yes | RA5000 Yes |