Header_Audio_APIHeader_Audio_API

Develop apps to control Sony's latest home audio devices

API References

The API works with both HTTP POST and/or WebSockets and uses JSON-RPC as message format. The control functions are available with both HTTP and WebSockets, but the notifications are only available then using WebSockets.

The order and number of the parameters in the examples can be different from your device response.

The entry point at default is http://ip.number.to.device:10000/sony/{Lib} for soundbars and receivers, and http://ip.number.to.device:54480/sony/{Lib} for wireless speakers.

If the lib is Common APIs in the description, This API exists for all lib’s and can give different result for dependent on lib.
Elements description
type

The expected parameter type, valid types are:

Type Explanation

boolean

true or false.

boolean-array

Boolean, true or false, stored in an array.

integer

Integer number, max ranging from -2147483648 to 2147483647.

integer-array

Integer numbers stored in an array.

double

Double number, max ranging from -2.2250738585072014e-308 to 1.7976931348623157e+308.

double-array

Double numbers stored in an array.

string

string value. Unless otherwise mentioned in each API spec, encoded with UTF-8.

string-array

Strings stored in an array.

(object)

Sub-object see format description for object element description.

(object-array)

Objects stored in an array.

Multiplicity
1

Required Once

?

Zero or Once (Optional)

*

Zero or More (Optional)

Default

Is the value that data receiver will in case specific parameter is missing, (Optional) parameters.


getCurrentExternalTerminalsStatus (v1.0)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets information about the current status of all external input and output terminal sources of the device. For a device that has no external input or output connectors, this APi should return an empty result with no error codes.

setActiveTerminal (v1.0)

Activates or deactivates an input or output terminal.

Request

Format description

{
 "id":"integer",
 "method":"getCurrentExternalTerminalsStatus",
 "params":[],
 "version":"v1.0"
}

Examples

{
 "method":"getCurrentExternalTerminalsStatus",
 "id":65,
 "params":[],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "active":"string",
    "connection":"string",
    "iconUrl":"string",
    "label":"string",
    "meta":"string",
    "outputs":"[string]",
    "title":"string",
    "uri":"string"
   }
  ]
 ]
}

result Elements

active
default

""

multiplicity

?

type

string

The active status of the terminal. For a terminal type of "meta:zone:output", the active status indicates whether the zone is enabled. For all other terminal types, the active status indicates whether the source is selected as an input source for any output zone.

  • "" - The active status could not be determined.
  • "active" - The terminal is enabled or a selected input source.
  • "inactive" - The terminal is disabled or not a selected input source.

connection
multiplicity

1

type

string

The connection status of the terminal.

  • "connected" - The terminal is connected.
  • "unconnected" - The terminal is not connected.
  • "unknown" - The connection status is unknown.

iconUrl
default

""

multiplicity

?

type

string

The icon URL that the service uses for the terminal, or "" if the service does not define an icon.

label
default

""

multiplicity

?

type

string

The label that the user assigned to this terminal.

  • (ex) "Game"

meta
default

""

multiplicity

?

type

string

Describes the type of terminal. For example, this can provide a hint to an application as to which icon to show to the user. The type is provided using a "meta" URI format. Your application should customize its UI based on the type of the terminal, such as choosing an appropriate image. The following meta URIs are defined, not all are used by all products:

  • "" - No meta information is available for this terminal
  • "meta:audiosystem" - An audio system type CEC device is connected to the terminal
  • "meta:avamp" - An AV amplifier is connected to the terminal
  • "meta:bd-dvd" - BD/DVD input
  • "meta:btaudio" - Bluetooth audio input
  • "meta:btphone" - BT phone input
  • "meta:camcoder" - A video camera is connected to the terminal
  • "meta:coaxial" - Coaxial digital audio input
  • "meta:complex" - A complex device is connected to the terminal
  • "meta:component" - Component input (Y and Pb/Cb and Pr/Cr connectors)
  • "meta:componentd" - D-Component input
  • "meta:composite" - Composite input
  • "meta:composite_componentd" - Composite and D-Component combined input
  • "meta:digitalcamera" - A digital camera is connected to the terminal
  • "meta:disc" - A disk player is connected to the terminal
  • "meta:dsub15" - D-subminiature 15pin input
  • "meta:game" - A game console is connected to the terminal
  • "meta:hdmi" - HDMI input
  • "meta:hdmi:output" - HDMI output
  • "meta:hometheater" - A home theater device is connected to the terminal
  • "meta:line" - Axillary input
  • "meta:linemini" - A mini audio port, the exact hardware port is device dependent
  • "meta:optical" - Optical digital audio input
  • "meta:pc" - A personal computer is connected to the terminal
  • "meta:playbackdevice" - A playback type CEC device is connected to the terminal
  • "meta:recordingdevice" - A recording type CEC device is connected to the terminal
  • "meta:scart" - SCART input
  • "meta:svideo" - S-Video input
  • "meta:tape" - A tape player is connected to the terminal
  • "meta:tuner" - A tuner is connected to the terminal
  • "meta:tunerdevice" - A tuner type CEC device is connected to the terminal
  • "meta:tv" - A TV type CEC device is connected to the terminal
  • "meta:usbdac" - USB DAC input
  • "meta:wifidisplay" - WiFi Display input
  • "meta:wirelessTransceiver:output" - Wireless transceiver
  • "meta:source" - Source input
  • "meta:sacd-cd" - SACD/CD input
  • "meta:sat-catv" - SAT/CATV input
  • "meta:video" - Video input
  • "meta:zone:output" - Zone output

outputs
default

null

multiplicity

?

type

string-array

An array of the URIs of the output terminals that are available for this input terminal . For more information about the URI structure, see the Device Resource URI page. For an output terminal, this parameter is omitted or its value is null.

title
multiplicity

1

type

string

The name of the input or output terminal.

  • (ex) "HDMI 2"
  • (ex) "Component 1"

uri
multiplicity

1

type

string

The URI of the external terminal. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extInput:hdmi?port=2"

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "outputs":[
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:source",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"Source",
    "uri":"extInput:source"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:bd-dvd",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":" BD/DVD ",
    "uri":"extInput:bd-dvd"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:game",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":" GAME ",
    "uri":"extInput:game"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:sat-catv",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"SAT/CATV",
    "uri":"extInput:sat-catv"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:video",
    "active":"active",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"VIDEO 1 ",
    "uri":"extInput:video?port=1"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:video",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"VIDEO 2 ",
    "uri":"extInput:video?port=2"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1"
    ],
    "meta":"meta:tv",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":" TV ",
    "uri":"extInput:tv"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3",
     "extOutput:zone?zone=4"
    ],
    "meta":"meta:sacd-cd",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"SA-CD/CD",
    "uri":"extInput:sacd-cd"
   },
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3"
    ],
    "meta":"meta:btaudio",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"Bluetooth Audio",
    "uri":"extInput:btAudio"
   },
   {
    "meta":"meta:zone:output",
    "active":"active",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"Zone 2",
    "uri":"extOutput:zone?zone=2"
   },
   {
    "meta":"meta:zone:output",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"Zone 3",
    "uri":"extOutput:zone?zone=3"
   },
   {
    "meta":"meta:zone:output",
    "active":"inactive",
    "connection":"unknown",
    "iconUrl":"",
    "label":"",
    "title":"HDMI Zone",
    "uri":"extOutput:zone?zone=4"
   }
  ]
 ],
 "id":65
}

getCustomEqualizerSettings (v1.0)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080

Description

Gets information about the current custom equalizer settings.

setCustomEqualizerSettings (v1.0)

Sets custom equalizer settings.

Request

Format description

{
 "id":"integer",
 "method":"getCustomEqualizerSettings",
 "params":[
  {
   "target":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

target
type

string

multiplicity

?

default

""

The name for the equalizer setting to get. Use "" to get all equalizer settings.

  • "100HzBandLevel" - The level for the 100 Hz band in the equalizer.
  • "330HzBandLevel" - The level for the 330 Hz band in the equalizer.
  • "1000HzBandLevel" - The level of the 1,000 Hz band in the equalizer.
  • "3300HzBandLevel" - The level of the 3,300 Hz band in the equalizer.
  • "10000HzBandLevel" - The level of the 10,000 Hz band in the equalizer.
  • "frontBassLevel" - The level of the front bass in the equalizer.
  • "frontTrebleLevel" - The level of the front treble in the equalizer.
  • "centerBassLevel" - The level of the center bass in the equalizer.
  • "centerTrebleLevel" - The level of the center treble in the equalizer.
  • "surroundBassLevel" - The level of the surround bass in the equalizer.
  • "surroundTrebleLevel" - The level of the surround treble in the equalizer.
  • "frontHighBassLevel" - The level of the front high bass in the equalizer.
  • "frontHighTrebleLevel" - The level of the front high treble in the equalizer.
  • "bassLevel" - The level of the bass in the equalizer.
  • "trebleLevel" - The level of the treble in the equalizer.
  • "" - All equalizer settings.

Examples

{
 "method":"getCustomEqualizerSettings",
 "id":11,
 "params":[
  {
   "target":"100HzBandLevel"
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "candidate":[
     {
      "isAvailable":"boolean",
      "max":"double",
      "min":"double",
      "step":"double",
      "title":"string",
      "titleTextID":"string",
      "value":"string"
     }
    ],
    "currentValue":"string",
    "deviceUIInfo":"string",
    "isAvailable":"boolean",
    "target":"string",
    "title":"string",
    "titleTextID":"string",
    "type":"string"
   }
  ]
 ]
}

result Elements

candidate
default

null

multiplicity

?

type

(object-array)

Gets a one-element array that provides additional information about the equalizer setting. If the equalizer setting is not available on this audio product, then this property will be null.

candidate.isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the equalizer setting is currently available.

candidate.max
default

-1

multiplicity

?

type

double

The maximum value of the equalizer setting, or -1 if the value type is non-numeric.

candidate.min
default

-1

multiplicity

?

type

double

The minimum value of the equalizer setting, or -1 if the value type is non-numeric.

candidate.step
default

-1

multiplicity

?

type

double

The step value of the equalizer setting, or -1 if the value type is non-numeric.

candidate.title
default

""

multiplicity

?

type

string

The display title for the equalizer setting. "" indicates that this setting has no assigned title.

candidate.titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the services uses to identify the equalizer setting. "" indicates that this setting has no assigned identifier.

candidate.value
default

""

multiplicity

?

type

string

The current value of the equalizer setting. If this property is "" or omitted, then the current value of the setting is an integer in a defined range with a fixed step.

currentValue
multiplicity

1

type

string

The current value of the equalizer setting. The value is unitless and device dependent.

  • In case "target" is "100HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "330HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "1000HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "3300HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "10000HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "centerBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "centerTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "surroundBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "surroundTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontHighBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontHighTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "bassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "trebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.

deviceUIInfo
default

""

multiplicity

?

type

string

How the device displays UI information for the equalizer setting. This format is product specific.

isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the equalizer setting is currently available.

target
multiplicity

1

type

string

The name of the equalizer setting.

  • "100HzBandLevel" - The level for the 100 Hz band in the equalizer.
  • "330HzBandLevel" - The level for the 330 Hz band in the equalizer.
  • "1000HzBandLevel" - The level of the 1,000 Hz band in the equalizer.
  • "3300HzBandLevel" - The level of the 3,300 Hz band in the equalizer.
  • "10000HzBandLevel" - The level of the 10,000 Hz band in the equalizer.
  • "frontBassLevel" - The level of the front bass in the equalizer.
  • "frontTrebleLevel" - The level of the front treble in the equalizer.
  • "centerBassLevel" - The level of the center bass in the equalizer.
  • "centerTrebleLevel" - The level of the center treble in the equalizer.
  • "surroundBassLevel" - The level of the surround bass in the equalizer.
  • "surroundTrebleLevel" - The level of the surround treble in the equalizer.
  • "frontHighBassLevel" - The level of the front high bass in the equalizer.
  • "frontHighTrebleLevel" - The level of the front high treble in the equalizer.
  • "bassLevel" - The level of the bass in the equalizer.
  • "trebleLevel" - The level of the treble in the equalizer.

title
default

""

multiplicity

?

type

string

The display title for the equalizer setting. "" indicates that this setting has no assigned title.

titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the equalizer setting. "" indicates that this setting has no assigned identifier.

type
default

""

multiplicity

?

type

string

The value type of the currentValue property for the equalizer setting.

  • "" - Type information is unavailable.
  • "booleanTarget" - A Boolean type containing only two values. For example: "off" and "on", or "false" and "true".
  • "doubleNumberTarget" - A number type, including floating point numbers. For example: "1.5", "-10.0".
  • "enumTarget" - An enumeration type containing a finite set of values. For example: "high", "mid", "low".
  • "integerTarget" - An integer type. For example: "1", "-10".
  • "stringTarget" - A string type. For example: "hello".

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "isAvailable":true,
    "candidate":[
     {
      "isAvailable":true,
      "min":-10,
      "max":10,
      "step":1
     }
    ],
    "titleTextID":"sound-equalizer-custom",
    "title":"100Hz",
    "type":"integerTarget",
    "currentValue":"3",
    "target":"100HzBandLevel"
   }
  ]
 ],
 "id":11
}

getInterfaceInformation (v1.0)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

This API provides information of WebAPI interface provided by the server. This API must not include private information.

getSystemInformation (v1.4)

Gets general system information for the device.

Request

Format description

{
 "id":"integer",
 "method":"getInterfaceInformation",
 "params":[],
 "version":"v1.0"
}

Examples

{
 "method":"getInterfaceInformation",
 "id":33,
 "params":[],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  {
   "interfaceVersion":"string",
   "modelName":"string",
   "productCategory":"string",
   "productName":"string",
   "serverName":"string"
  }
 ]
}

result Elements

interfaceVersion
multiplicity

1

type

string

Version for client to change its behavior w.r.t significant difference within productCategory . This version is managed/controlled within each productCategory . This parameter is composed of "[X].[Y].[Z]", where [X], [Y] and [Z] are string representing integer and concatenated with period "." in between.

modelName
multiplicity

1

type

string

Model name.

productCategory
multiplicity

1

type

string

Category name of device.

  • "camera" - Cameras and Camcorders.
  • "tv" - TV.
  • "internetTV" - Internet player with Google TV.
  • "videoServer" - The device that can serve downloadable video contents.
  • "homeTheaterSystem" - Home theater system.
  • "videoPlayer" - Video Player.
  • "personalAudio" - Personal Audio product.

productName
multiplicity

1

type

string

More detail product information can be returned if productCategory is not enough.

serverName
multiplicity

1

type

string

Server name. In case device can launch multiple Scalar WebAPI servers, return this server's name for client to distinguish.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  {
   "modelName":"KDL-L32HVX",
   "serverName":"",
   "interfaceVersion":"1.0.1",
   "productName":"WEGA",
   "productCategory":"tv"
  }
 ],
 "id":33
}

getPlaybackModeSettings (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Get the current playback mode settings. Not all settings are valid for all products. Use "" for the target to get the valid settings for the current product.

setPlaybackModeSettings (v1.0)

Updates the current playback mode settings.

Request

Format description

{
 "id":"integer",
 "method":"getPlaybackModeSettings",
 "params":[
  {
   "target":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

target
type

string

multiplicity

?

default

""

The name of the playback mode setting to get. Use "" to get the valid settings for the current product

  • "" - All playback settings.
  • "autoPlayback" - Set whether playback starts automatically.
  • "playType" - Playback Mode
  • "repeatType" - Repeat type
  • "shuffleType" - Shuffle type.

uri
type

string

multiplicity

?

default

null

If a device supports multiple sources for the setting, include the URI of the specific source for which to get information. For more information about the URI structure, see the Device Resource URI page. If this is skipped or "" is set, it means all sources for the mode.

Examples

{
 "method":"getPlaybackModeSettings",
 "id":28,
 "params":[
  {
   "target":"repeatType"
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "candidate":[
     {
      "isAvailable":"boolean",
      "max":"double",
      "min":"double",
      "step":"double",
      "title":"string",
      "titleTextID":"string",
      "value":"string"
     }
    ],
    "currentValue":"string",
    "deviceUIInfo":"string",
    "isAvailable":"boolean",
    "target":"string",
    "title":"string",
    "titleTextID":"string",
    "type":"string",
    "uri":"string"
   }
  ]
 ]
}

result Elements

candidate
default

null

multiplicity

?

type

(object-array)

Gets an array that provides additional information about the setting. If the setting is not available on this product, then this property will be null.

candidate.isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the setting is currently available.

candidate.max
default

-1

multiplicity

?

type

double

The maximum value of the setting, or -1 if the value type is non-numeric.

candidate.min
default

-1

multiplicity

?

type

double

The minimum value of the setting, or -1 if the value type is non-numeric.

candidate.step
default

-1

multiplicity

?

type

double

The step value of the setting, or -1 if the value type is non-numeric.

candidate.title
default

""

multiplicity

?

type

string

The display title for the setting. "" indicates that this setting has no assigned title.

candidate.titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the setting. "" indicates that this setting has no assigned identifier.

candidate.value
default

""

multiplicity

?

type

string

The current value of the setting. If this property is "" or omitted, then the current value of the setting is an integer in a defined range with a fixed step.

currentValue
multiplicity

1

type

string

The current value of the setting.

  • In case "target" is "autoPlayback"
    • "on" - Enable auto playback function.
    • "off" - Disable auto playback function.
  • In case "target" is "playType"
    • "normal" - Normal playback
    • "folder" - Playback enabled for a unit of folder and its subfolder
    • "repeatAll" - In case current composed of multiple parts, repeat playback enabled for whole parts.
    • "repeatFolder" - Repeat playback enabled for a unit of folder and its subfolder.
    • "repeatTrack" - Repeat playback enabled for a unit of track (audio content) or title (video content).
    • "shuffleAll" - In case current composed of multiple parts, shuffle playback enabled for whole parts.
  • In case "target" is "repeatType"
    • "all" - In case current composed of multiple parts, repeat playback enabled for whole parts.
    • "folder" - Repeat playback enabled for a unit of folder and its subfolder.
    • "track" - Repeat playback enabled for a unit of track (audio content) or title (video content).
    • "chapter" - Repeat playback enabled for a unit of chapter.
    • "off" - Repeat playback disabled as a device setting.
  • In case "target" is "shuffleType"
    • "folder" - Shuffle of a unit of folder and its subfolder. of file name.
    • "off" - Shuffle playback disabled as a device setting.

deviceUIInfo
default

""

multiplicity

?

type

string

How the device displays UI information for the setting. This format is product specific.

isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the setting is currently available.

target
multiplicity

1

type

string

The name of the playback mode setting.

  • "autoPlayback" - Set whether playback starts automatically.
  • "playType" - Playback Mode
  • "repeatType" - Repeat type
  • "shuffleType" - Shuffle type.

title
default

""

multiplicity

?

type

string

The display title for the setting. "" indicates that this setting has no assigned title.

titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the setting. "" indicates that this setting has no assigned identifier.

type
default

""

multiplicity

?

type

string

The value type of the currentValue property for the setting.

  • "" - Type information is unavailable.
  • "booleanTarget" - A Boolean type containing only two values. For example: "off" and "on", or "false" and "true".
  • "doubleNumberTarget" - A number type, including floating point numbers. For example: "1.5", "-10.0".
  • "enumTarget" - An enumeration type containing a finite set of values. For example: "high", "mid", "low".
  • "integerTarget" - An integer type. For example: "1", "-10".
  • "stringTarget" - A string type. For example: "hello".

uri
default

""

multiplicity

?

type

string

The URI of the specific source to which this setting applies, or "" if the device has only one source for the setting. For more information about the URI structure, see the Device Resource URI page.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "isAvailable":true,
    "candidate":[
     {
      "isAvailable":true,
      "title":"All",
      "value":"folder"
     },
     {
      "isAvailable":true,
      "title":"Folder",
      "value":"folder"
     },
     {
      "isAvailable":true,
      "title":"Track",
      "value":"track"
     },
     {
      "isAvailable":true,
      "title":"Off",
      "value":"off"
     }
    ],
    "currentValue":"off",
    "target":"repeatType"
   }
  ]
 ],
 "id":28
}

getPlayingContentInfo (v1.2)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets information about the playing content or current selected input. If the device is not currently playing content, then the response state parameter is "STOPPED".

notifyPlayingContentInfo (v1.0)

The notification sent by a device when its playing content or active input changes.

Request

Format description

{
 "id":"integer",
 "method":"getPlayingContentInfo",
 "params":[
  {
   "output":"string"
  }
 ],
 "version":"v1.2"
}

params Elements

output
type

string

multiplicity

?

default

""

The URI of the output. Omit this field or use "" to affect all outputs for the device. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"getPlayingContentInfo",
 "id":37,
 "params":[
  {
   "output":"extOutput:zone?zone=1"
  }
 ],
 "version":"1.2"
}

Response

Format description

When source is cast:audio
{
 "id":"integer",
 "result":[
  [
   {
    "applicationName":"string",
    "source":"cast:audio",
    "title":"string",
    "uri":"string"
   }
  ]
 ]
}
When source is netService:audio
{
 "id":"integer",
 "result":[
  [
   {
    "albumName":"string",
    "artist":"string",
    "contentKind":"string",
    "output":"string",
    "service":"string",
    "source":"netService:audio",
    "stateInfo":{
     "state":"string"
    },
    "title":"string",
    "uri":"string"
   }
  ]
 ]
}
When source is extInput:*
{
 "id":"integer",
 "result":[
  [
   {
    "contentKind":"string",
    "output":"string",
    "source":"extInput:*",
    "title":"string",
    "uri":"string"
   }
  ]
 ]
}
When source is radio:*
{
 "id":"integer",
 "result":[
  [
   {
    "broadcastFreq":"integer",
    "broadcastFreqBand":"string",
    "channelName":"string",
    "contentKind":"string",
    "dabInfo":{
     "componentLabel":"string",
     "dynamicLabel":"string",
     "ensembleLabel":"string",
     "serviceLabel":"string"
    },
    "fileNo":"string",
    "output":"string",
    "parentUri":"string",
    "source":"radio:*",
    "stateInfo":{
     "state":"string",
     "supplement":"string"
    },
    "title":"string",
    "totalCount":"integer",
    "uri":"string"
   }
  ]
 ]
}
When source is storage:*
{
 "id":"integer",
 "result":[
  [
   {
    "albumName":"string",
    "artist":"string",
    "audioInfo":[
     {
      "channel":"string",
      "codec":"string",
      "frequency":"string"
     }
    ],
    "contentKind":"string",
    "durationMsec":"integer",
    "fileNo":"string",
    "genre":"[string]",
    "index":"integer",
    "output":"string",
    "parentUri":"string",
    "playlistName":"string",
    "podcastName":"string",
    "positionMsec":"integer",
    "source":"storage:*",
    "sourceLabel":"string",
    "stateInfo":{
     "state":"string",
     "supplement":"string"
    },
    "title":"string",
    "totalCount":"integer",
    "uri":"string",
    "videoInfo":{
     "codec":"string"
    }
   }
  ]
 ]
}
When source is dlna:*
{
 "id":"integer",
 "result":[
  [
   {
    "contentKind":"string",
    "durationMsec":"integer",
    "durationSec":"double",
    "mediaType":"string",
    "output":"string",
    "playSpeed":"string",
    "playSpeedStep":"integer",
    "positionMsec":"integer",
    "positionSec":"double",
    "repeatType":"string",
    "source":"dlna:*",
    "title":"string",
    "uri":"string"
   }
  ]
 ]
}

result Elements

albumName
default

null

multiplicity

?

type

string

The Album name for the content, or null or omitted if no album name is defined.

applicationName
default

null

multiplicity

?

type

string

The name of the application that is playing the content, or null or omitted if it is undefined. If the content is streaming via the Cast for Audio service, the name of the casted application is used.

artist
default

null

multiplicity

?

type

string

The artist's name, or null or omitted if no artist name is defined.

audioInfo
default

null

multiplicity

?

type

(object-array)

Audio information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

audioInfo.channel
default

""

multiplicity

?

type

string

The number of audio channels.

audioInfo.codec
default

""

multiplicity

?

type

string

The audio codec for the content.

  • "" - unknown
  • "aac-lc"
  • "f1-lpcm"
  • "lpcm"

audioInfo.frequency
default

""

multiplicity

?

type

string

The sampling audio frequency in Hz, or "" if it is unavailable.

  • (ex) "44100"
  • (ex) "88200"
  • (ex) "96000"

broadcastFreq
default

-1

multiplicity

?

type

integer

The broadcast frequency for the content, in Hz.

broadcastFreqBand
default

""

multiplicity

?

type

string

The broadcast frequency band for the content.

  • "" - No band data
  • "am" - AM
  • "fm" - FM
  • "lw" - LW
  • "mw" - MW
  • "sw" - SW

channelName
default

null

multiplicity

?

type

string

The name of the broadcast channel, or null if it is undefined.

contentKind
default

""

multiplicity

?

type

string

Identifies the content type.

  • "" - Unknown
  • "directory" - Directory
  • "input" - External input
  • "movie" - Movie
  • "movie_avi" - AVI movie
  • "movie_mp4" - MP4 movie
  • "movie_xavcs" - XAVC S movie
  • "music" - Music
  • "radio" - Radio
  • "service" - Network service
  • "still" - Still image
  • "still_group" - Still group

dabInfo
default

null

multiplicity

?

type

(object)

Digital Audio Broadcasting ( DAB ) information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

dabInfo.componentLabel
default

null

multiplicity

?

type

string

The component label, for a service which carries either audio or data, or null or omitted if not available.

  • (ex) "BBC Asian Network"

dabInfo.dynamicLabel
default

null

multiplicity

?

type

string

The dynamic label, such as song title or text information of advertisement, or null or omitted if not available.

dabInfo.ensembleLabel
default

null

multiplicity

?

type

string

The ensemble label, which identifies an ensemble in a textual format, or null or omitted if not available.

  • (ex) "BBC National DAB"

dabInfo.serviceLabel
default

null

multiplicity

?

type

string

The service label, which identifies a service in a textual format, or null or omitted if not available.

  • (ex) "BBC Asian Network"

durationMsec
default

-1

multiplicity

?

type

integer

The length of the content, in milliseconds, or -1 if it is undefined.

durationSec
default

-1

multiplicity

?

type

double

Deprecated for unit consistency with other APIs. The length of the content, in seconds, or -1 if it is undefined.

fileNo
default

""

multiplicity

?

type

string

The file number of the content. What a file represents depends on the content type, such as a track or a broadcast preset item.

genre
default

null

multiplicity

?

type

string-array

The genres assigned to the content, or null or omitted if no genres are assigned. This is used for display purpose and is device-dependent.

index
default

0

multiplicity

?

type

integer

The index of the content list.

mediaType
default

""

multiplicity

?

type

string

The media type of the playing content.

  • "" - unknown type
  • "audio" - audio(music) content
  • "image" - image(photo) content
  • "video" - video content

output
default

""

multiplicity

?

type

string

The URI of the output terminal on which the content is playing. To get information about the current status of all external output terminal sources of the device, see the v1_0.getCurrentExternalTerminalsStatus method. For more information about the URI structure, see the Device Resource URI page.

parentUri
default

""

multiplicity

?

type

string

The URI of the parent directory if the source is browsable; otherwise "".

playSpeed
default

"1.0"

multiplicity

?

type

string

The current play speed, expressed as a number with one decimal place.

  • (ex) "1.0"
  • (ex) "1.5"

playSpeedStep
default

0

multiplicity

?

type

integer

The playback speed setting of the content. Positive numbers represent fast-forward settings, with greater numbers representing faster speeds. Negative numbers represent slow-motion settings, with lesser numbers representing slower speeds. The playback speed for each setting is device dependent.

  • 3 - Fast forward
  • 2 - Fast forward
  • 1 - Fast forward
  • 0 - Normal speed
  • -1 - Slow motion
  • -2 - Slow motion
  • -3 - Slow motion

playlistName
default

null

multiplicity

?

type

string

The name of the playlist in which the content is included, or null or omitted if no playlist is defined.

podcastName
default

null

multiplicity

?

type

string

The name of the podcast, or null or omitted if this content is not from a podcast.

positionMsec
default

0

multiplicity

?

type

integer

The playing position within the content, in milliseconds.

positionSec
default

0

multiplicity

?

type

double

Deprecated for unit consistency with other APIs. The playing position within the content, in seconds.

repeatType
default

"off"

multiplicity

?

type

string

The repeat setting for the current content.

  • "off" - Repeat playback disabled for the single unit of content currently playing.
  • "on" - Repeat playback enabled for the single unit of content currently playing.

service
default

""

multiplicity

?

type

string

The URI for service information if the device is playing network service content; otherwise "". You can use this URI to retrieve service information about the playing content.

source
default

""

multiplicity

?

type

string

The source of the playing content, described by the base URI of the content, or "" if it is undefined.

sourceLabel
default

null

multiplicity

?

type

string

The display name of the source of the playing content, or null if it is undefined.

stateInfo
default

null

multiplicity

?

type

(object)

The playback status of the device. If a value for this field is included in the notification, at least one of its fields will contain a value.

stateInfo.state
multiplicity

1

type

string

Playing status

  • "PLAYING" - Content is being played
  • "STOPPED" - Content is stopped
  • "PAUSED" - Content is pausing
  • "FORWARDING" - Content is being forwarded.

stateInfo.supplement
default

null

multiplicity

?

type

string

Supplemental information about the playback status the device.

  • null - No supplemental information.
  • "alarmInterrupting" - Interrupting and switching to Emergency Warning System.
  • "automaticMusicScanning" - Changing to next content by AMS (Automatic Music Scan) function.
  • "autoPresetting" - Presetting broadcast stations automatically.
  • "autoScanning" - Scanning for DAB digital radio automatically.
  • "bwdSeeking" - Backward seeking broadcast stations.
  • "enumerating" - Enumerating storage device.
  • "fwdSeeking" - Forward seeking broadcast stations.
  • "initialScanning" - Initial scanning for DAB digital radio.
  • "loading" - Loading a disc storage device.
  • "manualSeeking" - Seeking broadcast stations manually.
  • "noContent" - There is no content that can be played back.
  • "noMedia" - There is no media.
  • "noNextContent" - There is no next content in current playback scope.
  • "noPreviousContent" - There is no previous content in current playback scope.
  • "notAvailable" - A device can not play back for some reason.
  • "presetMemorizing" - Memorizing preset of broadcast station.
  • "reading" - Reading a structure of storage device.
  • "receiving" - Receiving DAB digital radio. (Before initial scan of DAB etc.)
  • "uncontrollable" - This content can not be controlled such as pause, stop, or scan by pausePlayingContent, stopPlayingContent, setPlaySpeed, or scanPlayingContent, and so on.

title
default

null

multiplicity

?

type

string

The display title of the playing content, or null if it is undefined.

  • (ex) "My Movie"

totalCount
default

-1

multiplicity

?

type

integer

The number of content items in the playback scope, or -1 if it is unknown.

uri
multiplicity

1

type

string

The full URI of the playing content, or "" if no content is playing. For more information about the URI structure, see the Device Resource URI page.

videoInfo
default

null

multiplicity

?

type

(object)

Video information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

videoInfo.codec
default

""

multiplicity

?

type

string

The video codec for the content.

  • "" - unknown
  • "avc" - MPEG4 AVC
  • "mpeg1" - MPEG1 VIDEO
  • "mpeg2" - MPEG2 VIDEO
  • "mpeg4" - MPEG4 VIDEO
  • "vc1" - VC1
  • "xvid" - Xvid
  • "wmv" - WMV

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

Example of audio content.
{
 "result":[
  [
   {
    "output":"extOutput:zone?zone=1",
    "albumName":"THE BEATLES disc1",
    "contentKind":"music",
    "parentUri":"storage:usb1?path=/music",
    "artist":"The Beatles",
    "durationMsec":167000,
    "positionMsec":4000,
    "stateInfo":{
     "state":"PLAYING"
    },
    "source":"storage:usb1",
    "title":"NOWHERE MAN",
    "uri":"storage:usb1?path=/music/07%20NOWHERE%20MAN.wma"
   }
  ]
 ],
 "id":37
}
Example of radio content.
{
 "result":[
  [
   {
    "output":"extOutput:zone?zone=1",
    "contentKind":"radio",
    "parentUri":"radio:fm",
    "broadcastFreqBand":"fm",
    "fileNo":"0",
    "broadcastFreq":85900000,
    "stateInfo":{
     "state":"PLAYING"
    },
    "source":"radio:fm",
    "title":"",
    "totalCount":30,
    "uri":"radio:fm?contentId=0"
   }
  ]
 ],
 "id":37
}
Example of External input content.
{
 "result":[
  [
   {
    "output":"extOutput:zone?zone=1",
    "contentKind":"input",
    "source":"extInput:tv",
    "uri":"extInput:tv"
   }
  ]
 ],
 "id":37
}
Example of no playing content.
{
 "result":[
  [
   {
    "output":"extOutput:zone?zone=1",
    "stateInfo":{
     "state":"STOPPED"
    },
    "source":"storage:usb1",
    "uri":""
   }
  ]
 ],
 "id":37
}

getPowerStatus (v1.1)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets the current power status of the device.

setPowerStatus (v1.1)

Sets the power status of the device.

Request

Format description

{
 "id":"integer",
 "method":"getPowerStatus",
 "params":[],
 "version":"v1.1"
}

Examples

{
 "method":"getPowerStatus",
 "id":50,
 "params":[],
 "version":"1.1"
}

Response

Format description

{
 "id":"integer",
 "result":[
  {
   "standbyDetail":"string",
   "status":"string"
  }
 ]
}

result Elements

standbyDetail
default

""

multiplicity

?

type

string

Additional information for the standby power state. If this value is omitted or "", then no additional information is available.

  • "" - No additional information is available.
  • "normalStandby" - The device is in its normal standby state.
  • "quickStartStandby" - The device is in its quick-start standby state. The device can transition quickly to an active state.

status
multiplicity

1

type

string

The current power status of the device, or the status to set.

  • "activating" - The device is transitioning to the power-on state.
  • "active" - The device is in the power-on state.
  • "shuttingDown" - The device is transitioning to the power-off state.
  • "standby" - The device is in the standby state. Network functions are active, and the device can switch to the power-on state via a network command. Not all products support standby, personalaudio products don't.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  {
   "status":"standby"
  }
 ],
 "id":50
}

getSWUpdateInfo (v1.0)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Checks whether firmware updates are available for the device.

Request

Format description

{
 "id":"integer",
 "method":"getSWUpdateInfo",
 "params":[
  {
   "network":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

network
type

string

multiplicity

?

default

""

Indicates whether to check the network for updates.

  • "" - The acquisition way is not specified.
  • "false" - Check for updates on a connected USB device.
  • "true" - Check for updates using the network.

Examples

{
 "method":"getSWUpdateInfo",
 "id":30,
 "params":[
  {
   "network":"true"
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  {
   "isUpdatable":"string",
   "swInfo":[
    {
     "estimatedTimeSec":"integer",
     "forcedUpdate":"string",
     "target":"string",
     "updatableVersion":"string"
    }
   ]
  }
 ]
}

result Elements

isUpdatable
multiplicity

1

type

string

Indicates whether an update is available.

  • "true" - A firmware update is available for the device.
  • "false" - A firmware update is not available for the device.

swInfo
default

null

multiplicity

?

type

(object-array)

An array of the available updates. Note that this API does not currently provide a way to update the software. For information on how to update the software, see the manual for the device.

swInfo.estimatedTimeSec
default

-1

multiplicity

?

type

integer

The estimated time required to update the application, in seconds; or -1 if the time is unknown.

swInfo.forcedUpdate
default

"false"

multiplicity

?

type

string

Indicates whether a forced update is required.

  • "true" - A forced update is required.
  • "false" - A forced update is not required.

swInfo.target
default

""

multiplicity

?

type

string

The application to which this update applies.

swInfo.updatableVersion
multiplicity

1

type

string

The version the application will be after the update.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  {
   "isUpdatable":"true",
   "swInfo":[
    {
     "estimatedTimeSec":180,
     "updatableVersion":"M29.R.0250"
    }
   ]
  }
 ],
 "id":30
}

getSchemeList (v1.0)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

This API provides the list of schemes that device can handle.

Request

Format description

{
 "id":"integer",
 "method":"getSchemeList",
 "params":[],
 "version":"v1.0"
}

Examples

{
 "method":"getSchemeList",
 "id":1,
 "params":[],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "scheme":"string"
   }
  ]
 ]
}

result Elements

scheme
multiplicity

1

type

string

Scheme name. Refer to here to know scheme and URI structure in detail.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "scheme":"tv"
   },
   {
    "scheme":"extInput"
   },
   {
    "scheme":"usb"
   },
   {
    "scheme":"iptv"
   },
   {
    "scheme":"disc"
   }
  ]
 ],
 "id":1
}

getSleepTimerSettings (v1.0)

Lib

system

Supported by

STR-DN1080

Description

Gets the sleep timer settings for the device.

setSleepTimerSettings (v1.0)

Sets the sleep timer settings for the device.

Request

Format description

{
 "id":"integer",
 "method":"getSleepTimerSettings",
 "params":[
  {
   "target":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

target
type

string

multiplicity

?

default

""

The name of the setting to get. Not all settings are valid for all products. Use "" for the target to get the valid settings for the current product.

  • "" - All sleep timer settings.
  • "sleepTimerMin" - The number of minutes after which to automatically turn off.

Examples

{
 "method":"getSleepTimerSettings",
 "id":97,
 "params":[
  {
   "target":"sleepTimerMin"
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "candidate":[
     {
      "isAvailable":"boolean",
      "max":"double",
      "min":"double",
      "step":"double",
      "title":"string",
      "titleTextID":"string",
      "value":"string"
     }
    ],
    "currentValue":"string",
    "deviceUIInfo":"string",
    "isAvailable":"boolean",
    "target":"string",
    "title":"string",
    "titleTextID":"string",
    "type":"string"
   }
  ]
 ]
}

result Elements

candidate
default

null

multiplicity

?

type

(object-array)

Gets an array that provides additional information about the setting. If the setting is not available on this product, then this property will be null.

candidate.isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the setting is currently available.

candidate.max
default

-1

multiplicity

?

type

double

The maximum value of the setting, or -1 if the value type is non-numeric.

candidate.min
default

-1

multiplicity

?

type

double

The minimum value of the setting, or -1 if the value type is non-numeric.

candidate.step
default

-1

multiplicity

?

type

double

The step value of the setting, or -1 if the value type is non-numeric.

candidate.title
default

""

multiplicity

?

type

string

The display title for the setting. "" indicates that this setting has no assigned title.

candidate.titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the setting. "" indicates that this setting has no assigned identifier.

candidate.value
default

""

multiplicity

?

type

string

The current value of the setting. If this property is "" or omitted, then the current value of the setting is an integer in a defined range with a fixed step.

currentValue
multiplicity

1

type

string

The current value of the setting.

  • In case "target" is "sleepTimerMin"
    • "120" - After 120 minutes.
    • "90" - After 90 minutes.
    • "80" - After 80 minutes.
    • "70" - After 70 minutes.
    • "60" - After 60 minutes.
    • "50" - After 50 minutes.
    • "40" - After 40 minutes.
    • "30" - After 30 minutes.
    • "20" - After 20 minutes.
    • "10" - After 10 minutes.
    • "off" - Do not automatically turn off.
    • "" - The current setting is unknown.

deviceUIInfo
default

""

multiplicity

?

type

string

How the device displays UI information for the setting. This format is product specific.

isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the setting is currently available.

target
multiplicity

1

type

string

The name of the sleep timer setting.

  • "sleepTimerMin" - The number of minutes after which to automatically turn off.

title
default

""

multiplicity

?

type

string

The display title for the setting. "" indicates that this setting has no assigned title.

titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the setting. "" indicates that this setting has no assigned identifier.

type
default

""

multiplicity

?

type

string

The value type of the currentValue property for the setting.

  • "" - Type information is unavailable.
  • "booleanTarget" - A Boolean type containing only two values. For example: "off" and "on", or "false" and "true".
  • "doubleNumberTarget" - A number type, including floating point numbers. For example: "1.5", "-10.0".
  • "enumTarget" - An enumeration type containing a finite set of values. For example: "high", "mid", "low".
  • "integerTarget" - An integer type. For example: "1", "-10".
  • "stringTarget" - A string type. For example: "hello".

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "isAvailable":true,
    "candidate":[
     {
      "isAvailable":true,
      "title":"120 min",
      "value":"120"
     },
     {
      "isAvailable":true,
      "title":"90 min",
      "value":"90"
     },
     {
      "isAvailable":true,
      "title":"60 min",
      "value":"60"
     },
     {
      "isAvailable":true,
      "title":"30 min",
      "value":"30"
     },
     {
      "isAvailable":true,
      "title":"Off",
      "value":"off"
     }
    ],
    "title":"Sleep Timer",
    "type":"enumTarget",
    "currentValue":"60",
    "target":"sleepTimerMin"
   }
  ]
 ],
 "id":97
}

getSoundSettings (v1.1)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets information about the current sound settings. Not all settings are valid for all products. Use "" for the target to get the valid settings for the current product.

setSoundSettings (v1.1)

Sets sound settings.

Request

Format description

{
 "id":"integer",
 "method":"getSoundSettings",
 "params":[
  {
   "target":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

target
type

string

multiplicity

?

default

""

The name of the sound setting to get. Use "" to get the valid settings for the current product.

  • "" - All sound settings.
  • "aac" - The output method for AAC signals.
  • "audioDRC" - The audio dynamic range compression (DRC) setting.
  • "audioPurenessControl" - Set whether changing screen to black to improve sound quality.
  • "audioPurenessControlTmp" - Set temporary whether changing screen to black to improve sound quality.
  • "autoFormatDirect_2ch" - Set Auto Format Direct (A.F.D)/2-channel sound mode
  • "autoGenreSelector" - To provide suitable Sound Field depending on the kind of contents, switch Sound Field automatically according to "Genre Info" on CEC.
  • "avSyncMs" - Set a delay time (ms) of input audio to adjust Audio and Video Sync. Note that the range and step values vary depending on device.
  • "bdMixMode" - The output method for the interactive audio and secondary audio (commentary) when playing a BD that contains such audio.
  • "calibrationType" - Set Calibration type after you have performed the Auto Calibration and saved the settings.
  • "clearAudio" - Clear Audio+ function
  • "convertToDolbyD" - Settings for Dolby Digital Converter Dolby D Compatible Output function which converts DTS source to Dolby Digital by referring EDID
  • "digitalAudioType" - The sound setting for the digital signal from the HDMI or DIGITAL OUT terminal.
  • "digitalMusicEnhancer" - Set Digital Music Enhancer function for output when playing Internet content or USB content.
  • "downMix" - The downmix setting, whether to enable surround effects or not when downmixing to PCM 2ch from a multi channel source, such as, BD LPCM, DTS HD, Dolby TrueHD, DD+, DD, DTS, or AAC.
  • "dsdMode" - The sound setting for HDMI when playing SACD audio from a DSD file.
  • "dseeHX" - Set whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "dseeHXTmp" - Set temporary whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "dtsNeo6" - Settings for DTS Neo:6.
  • "dualMono" - Set Dual Mono mode.
  • "footballMode" - Football Mode
  • "inputAttenuation" - Reduces the input sensitivity of audio signal input to Audio analog audio input terminal.
  • "nightMode" - Set Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "nightModeTmp" - Set temporary Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "optimizer" - Set Sound Optimizer function. Enjoying clear and dynamic sound at a low volume.
  • "outputTerminal" - Selecting speakers or terminals to output sound.
  • "pureDirect" - Set Pure Direct function. When the Pure Direct function is on, the display panel lights off to suppress noise that affects sound quality.
  • "sceneSelection" - Set Custom Preset scene. Each preset scene saves various settings with the player, monitor, etc., according to listening and viewing style.
  • "soundField" - The sound quality according to the music genre.
  • "soundFiedlMovie" - Set Sound Field Movie function.
  • "voice" - Set Voice mode. This helps make dialogues clearer.
  • "wideStereo" - Set Wide Stereo mode for immersive stereo sound.

Examples

{
 "method":"getSoundSettings",
 "id":73,
 "params":[
  {
   "target":"aac"
  }
 ],
 "version":"1.1"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "candidate":[
     {
      "isAvailable":"boolean",
      "max":"double",
      "min":"double",
      "step":"double",
      "title":"string",
      "titleTextID":"string",
      "value":"string"
     }
    ],
    "currentValue":"string",
    "deviceUIInfo":"string",
    "isAvailable":"boolean",
    "target":"string",
    "title":"string",
    "titleTextID":"string",
    "type":"string"
   }
  ]
 ]
}

result Elements

candidate
default

null

multiplicity

?

type

(object-array)

Gets a one-element array that provides additional information about the sound setting. If the sound setting is not available on this audio product, then this property will be null.

candidate.isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the sound setting is currently available.

candidate.max
default

-1

multiplicity

?

type

double

The maximum value of the sound setting, or -1 if the value type is non-numeric.

candidate.min
default

-1

multiplicity

?

type

double

The minimum value of the sound setting, or -1 if the value type is non-numeric.

candidate.step
default

-1

multiplicity

?

type

double

The step value of the sound setting, or -1 if the value type is non-numeric.

candidate.title
default

""

multiplicity

?

type

string

The display title for the sound setting. "" indicates that this setting has no assigned title.

candidate.titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the services uses to identify the sound setting. "" indicates that this setting has no assigned identifier.

candidate.value
default

""

multiplicity

?

type

string

The current value of the sound setting. If this property is "" or omitted, then the current value of the setting is an integer in a defined range with a fixed step.

currentValue
multiplicity

1

type

string

The current value of the sound setting.

  • In case "target" is "aac"
    • "downmixPcm" - Converted (downmixed) LPCM output
    • "aac" - AAC output
  • In case "target" is "audioDRC"
    • "auto" - The system uses DRC as set on the disc, only for BD-ROM.
    • "on" - The system uses DRC as set by the recording engineer.
    • "off" - The system disables DRC.
    • "standard" - The system uses DRC between "tv" and "wideRange".
    • "tv" - The system uses DRC that emphasizes faint sounds, for TV speakers.
    • "wideRange" - The system uses DRC optimized for Hi-Fi speakers.
  • In case "target" is "audioPurenessControl"
    • "on" - Enable APC function
    • "off" - Disable APC function
  • In case "target" is "audioPurenessControlTmp"
    • "on" - Enable APC function
    • "off" - Disable APC function
  • In case "target" is "autoGenreSelector"
    • "on" - Enable Auto Genre Selector function.
    • "off" - The Auto Genre selector function is disable.
  • In case "target" is "autoFormatDirect_2ch"
    • "2chStereo" - 2ch Stereo. The receiver outputs the sound from the front left/right speakers only. There is no sound from the subwoofer.
    • "analogDirect" - Analog Direct. You can switch the audio of the selected input to 2-channel analog input. This function enables you to enjoy high-quality analog sources.
    • "auto" - Auto Format Direct (A.F.D.) Presets the sound as it was recorded/encoded without adding any surround effects.
    • "multiStereo" - Multi stereo. Outputs 2-channel left/right or monaural signals from all speakers.
    • "surround" - This mode expands a 2 channel audio source to multi channel.
    • "off" - Disable A.F.D/2ch function
  • In case "target" is "avSyncMs"
    • 0 - Min value.
    • : (step by 25)
    • 300 - Max value.
  • In case "target" is "bdMixMode"
    • "on" - Outputs the audio obtained by mixing the interactive and secondary audio to the primary audio.
    • "off" - Outputs the primary audio only, outputs HD audio signals, such as Dolby TrueHD, to an AV Receiver.
  • In case "target" is "calibrationType"
    • "fullFlat" - Full Flat. Makes the measurement of frequency from each speaker flat.
    • "engineer" - Engineer. Sets to "the Sony listening room standard" frequency characteristics.
    • "frontReference" - Front Reference. Adjusts the characteristics of all of the speakers to match the characteristics of the front speaker.
    • "off" - Disable Calibration type.
  • In case "target" is "clearAudio"
    • "on" - Enable Clear Audio + function
    • "off" - Disable Clear Audio + function
  • In case "target" is "convertToDolbyD"
    • "on" - Convert DTS source to Dolby Digital by referring EDID.
    • "off" - Not convert DTS source to Dolby Digital
  • In case "target" is "dseeHX"
    • "auto" - Enable DSEE HX function only when sound is 2ch.
    • "on" - Enable DSEE HX function always regardless of the number of channel.
    • "off" - Disable DSEE HX function
  • In case "target" is "dseeHXTmp"
    • "auto" - Enable DSEE HX function only when sound is 2ch.
    • "on" - Enable DSEE HX function always regardless of the number of channel.
    • "off" - Disable DSEE HX function
  • In case "target" is "digitalAudioType"
    • "auto" - PCM and BitStream can switch automatically according to connection device.
    • "pcm" - PCM output from HDMI or digital audio output.
    • "multiPcm" - Multi channel PCM output from HDMI or digital audio output.
    • "2chPcm" - 2 channel PCM output from HDMI or digital audio output.
  • In case "target" is "digitalMusicEnhancer"
    • "on" - Three elements (PAE+(Portable Audio Enhancer Plus), Dynamic Range Recovery, Advanced Auto Volume) are enabled to create better sound quality for Internet content or USB content.
    • "off" - Turns off the Digital Music Enhancer function.
    • "soundBarMode" - Same as setting value "off", the purpose of this setting value is to force sound bar users to use off.
  • In case "target" is "downMix"
    • "surround" - Enables surround effects in audio output.
    • "stereo" - Disables surround effects in audio output.
  • In case "target" is "dsdMode"
    • "auto" - DSD output
    • "off" - PCM output
  • In case "target" is "dtsNeo6"
    • "cinema" - Neo:6 Cinema settings for movie.
    • "music" - Neo:6 Music settings for audio.
    • "off" - Disable Neo:6 function.
  • In case "target" is "dualMono"
    • "main_sub" - Main/Sub mode. Sound in the main language will be output through the front left speaker and sound in the sub language will be output through the front right speaker simultaneously.
    • "main" - Main mode. Sound in the main language will be output.
    • "sub" - Sub mode. Sound in the sub language will be output.
  • In case "target" is "footballMode"
    • "on" - Enable Football Mode with narration
    • "on_narration_off" - Enable Football Mode without narration
    • "off" - Disable Football Mode
  • In case "target" is "inputAttenuation"
    • "on" - Enable input attenuation function
    • "off" - Disable input attenuation function
  • In case "target" is "nightMode"
    • "on" - Enable Night mode.
    • "off" - Disable Night mode.
  • In case "target" is "nightModeTmp"
    • "on" - Enable Night mode.
    • "off" - Disable Night mode.
  • In case "target" is "optimizer"
    • "normal" - Normal mode. Adjusts for the reference level of a movie.
    • "low" - Low mode. Adjusts for a CD or other software whose average sound pressure level is processed highly.
    • "off" - Disable Sound Optimizer function.
  • In case "target" is "outputTerminal"
    • "speaker" - Audio is output from speaker.
    • "speaker_hdmi" - Audio is output from speaker and HDMI.
    • "hdmi" - Audio is output from HDMI.
    • "audioSystem" - Audio is output from HDMI or digital audio output.
  • In case "target" is "pureDirect"
    • "on" - Enable Pure Direct function.
    • "off" - Disable Pure Direct function.
  • In case "target" is "soundField"
    • "standard" - Music Equalizer Standard. Sound effects are optimized for the individual source.
    • "rock" - Music Equalizer Rock
    • "hiphop" - Music Equalizer Hip Hop
    • "electronica" - Music Equalizer Electronica
    • "sertanejo" - Music Equalizer Sertanejo
    • "movie" - Movie mode. Sound effects are optimized for movies. This mode replicates the density and rich expanse of sound.
    • "movie2" - Movie2 mode. Sound effects are optimized for movies. This mode replicates sound looping around the listener to the rear.
    • "music" - Music mode. Sound effects are optimized for music.
    • "game" - Game mode. Sound effects are optimized for game play.
    • "compressionMusic" - Digital Music mode
    • "night" - Night mode
    • "flat" - Flat mode
    • "pop" - Pop mode
    • "jazz" - Jazz mode. Reproduces the acoustics of a jazz club.
    • "latin" - Latin mode
    • "classic" - Classic mode
    • "custom" - Custom mode
    • "clearAudio" - Clear Audio + mode. The appropriate sound setting is automatically selected for the sound source.
    • "sports" - Sports mode. Reproduces the feel of sports broadcasting.
    • "live" - Live mode. Reproduces the acoustics of a 300-seat live house.
    • "stadium" - Stadium mode. Reproduces the feel of a large open-air stadium
    • "proLogicIIMusic" - Pro Logic II Music mode. Performs Dolby Pro Logic II Music mode decoding. This setting is ideal for normal stereo sources such as CDs.
    • "proLogicIIxMusic" - Pro Logic IIx Music mode. Performs Dolby Pro Logic IIx Music mode decoding. This setting is ideal for normal stereo sources such as CDs.
    • "neo6Music" - Neo6 Music mode. Performs DTS Neo:6 Music mode decoding. Sources recorded in 2-channel format are enhanced up to 7 channels. This setting is ideal for normal stereo sources such as CDs.
    • "concertHallA" - Concert Hall A. Reproduces the acoustics of a vineyard style concert hall in Berlin famous for its clear acoustics.
    • "concertHallB" - Concert Hall B. Reproduces the acoustics of a shoe box style concert hall with plaster walls in Amsterdam.
    • "concertHallC" - Concert Hall C. Reproduces the acoustics of a wooden shoe box style concert hall in Vienna.
    • "portableAudio" - Portable Audio. Reproduces clear enhanced sound from your portable audio device. This mode is ideal for MP3s and other compressed music.
    • "cinemaStudio" - Cinema Studio. Sound effect are optimized for higher realistic sound like a cinema studio.
    • "musicArena" - Music Arena. Sound effects like a live music concerts filled with great excitement created by Sony’s unique Audio DSP technology.
    • "headPhone2ch" - This mode is selected automatically when connecting headphones. Standard 2-channel stereo sources completely bypass the sound field processing and multi-channel surround formats are downmixed to 2 channels except LFE signals.
    • "off" - Disable Sound Field function.
  • In case "target" is "soundFiedlMovie"
    • "hdDcsDynamic" - HD Digital Cinema Sound (HD-D.C.S.) Dynamic. This setting is suitable for an environment which is reverberant but lacks a spacious feel (where sound absorption is not sufficient). It emphasizes the reflection of sound and reproduces the sound of a large, classic movie theater.
    • "hdDcsTheater" - HD Digital Cinema Sound (HD-D.C.S.) Theater. This setting is suitable for a general living room. It reproduces the reverberation of sound just like in a movie theater (dubbing theater). It is most appropriate for watching content recorded on a Blu-ray Disc when you want the atmosphere of a movie theater
    • "hdDcsStudio" - HD Digital Cinema Sound (HD-D.C.S.) Studio. This setting is suitable for a living room with the appropriate sound devices. It reproduces the reverberation of sound provided when a theatrical sound source is remixed for a Blu-ray Disc to a volume level suitable for home use.
    • "proLogicII" - Dolby Pro Logic II Movie mode decoding. This setting is ideal for movies encoded in Dolby Surround.
    • "proLogicIIx" - Dolby Pro Logic IIx Movie mode decoding. This setting expands Dolby Pro Logic II Movie or Dolby Digital 5.1 to 7.1 discrete movie channels.
    • "neo6Cinema" - DTS Neo:6 Cinema mode decoding. Sources recorded in 2-channel format are enhanced up to 7 channels.
    • "frontSurrond" - An immersive virtual surround sound experience with only front speakers.
    • "off" - Disable Sound Field Movie function.
  • In case "target" is "sceneSelection"
    • "movie" - Movie scene.
    • "music" - Music scene.
    • "party" - Party scene.
    • "night" - Night scene.
    • "undo" - Undo custom preset scene settings.
    • "" - Scene Selection Settings is Unknown.
  • In case "target" is "voice"
    • "type1" - Type 1. Standard.
    • "type2" - Type 2. Dialogue range is enhanced.
    • "type3" - Type 3. Dialogue range is enhanced, and the parts of range difficult to be discerned by the elderly are boosted.
  • In case "target" is "wideStereo"
    • "high" - Wide Stereo High mode.
    • "standard" - Wide Stereo Standard mode.

deviceUIInfo
default

""

multiplicity

?

type

string

How the device displays UI information for the sound setting. This format is product specific.

isAvailable
default

true

multiplicity

?

type

boolean

Indicates whether the sound setting is currently available.

target
multiplicity

1

type

string

The name of the sound setting.

  • "aac" - The output method for AAC signals.
  • "audioDRC" - The audio dynamic range compression (DRC) setting.
  • "audioPurenessControl" - Set whether changing screen to black to improve sound quality.
  • "audioPurenessControlTmp" - Set temporary whether changing screen to black to improve sound quality.
  • "autoGenreSelector" - To provide suitable Sound Field depending on the kind of contents, switch Sound Field automatically according to "Genre Info" on CEC.
  • "autoFormatDirect_2ch" - Set Auto Format Direct (A.F.D)/2-channel sound mode
  • "avSyncMs" - Set a delay time (ms) of input audio to adjust Audio and Video Sync. Note that the range and step values vary depending on device.
  • "bdMixMode" - The output method for the interactive audio and secondary audio (commentary) when playing a BD that contains such audio.
  • "calibrationType" - Set Calibration type after you have performed the Auto Calibration and saved the settings.
  • "clearAudio" - Clear Audio+ function
  • "convertToDolbyD" - Settings for Dolby Digital Converter Dolby D Compatible Output function which converts DTS source to Dolby Digital by referring EDID
  • "dseeHX" - Set whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "dseeHXTmp" - Set temporary whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "digitalAudioType" - The sound setting for the digital signal from the HDMI or DIGITAL OUT terminal.
  • "digitalMusicEnhancer" - Set Digital Music Enhancer function for output when playing Internet content or USB content.
  • "downMix" - The downmix setting, whether to enable surround effects or not when downmixing to PCM 2ch from a multi channel source, such as, BD LPCM, DTS HD, Dolby TrueHD, DD+, DD, DTS, or AAC.
  • "dsdMode" - The sound setting for HDMI when playing SACD audio from a DSD file.
  • "dtsNeo6" - Settings for DTS Neo:6.
  • "dualMono" - Set Dual Mono mode.
  • "footballMode" - Football Mode
  • "inputAttenuation" - Reduces the input sensitivity of audio signal input to Audio analog audio input terminal.
  • "nightMode" - Set Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "nightModeTmp" - Set temporary Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "optimizer" - Set Sound Optimizer function. Enjoying clear and dynamic sound at a low volume.
  • "outputTerminal" - Selecting speakers or terminals to output sound.
  • "pureDirect" - Set Pure Direct function. When the Pure Direct function is on, the display panel lights off to suppress noise that affects sound quality.
  • "soundField" - The sound quality according to the music genre.
  • "soundFiedlMovie" - Set Sound Field Movie function.
  • "sceneSelection" - Set Custom Preset scene. Each preset scene saves various settings with the player, monitor, etc., according to listening and viewing style.
  • "voice" - Set Voice mode. This helps make dialogues clearer.
  • "wideStereo" - Set Wide Stereo mode for immersive stereo sound.

title
default

""

multiplicity

?

type

string

The display title for the sound setting. "" indicates that this setting has no assigned title.

titleTextID
default

""

multiplicity

?

type

string

The product-specific identifier that the service uses to identify the sound setting. "" indicates that this setting has no assigned identifier.

type
default

""

multiplicity

?

type

string

The value type of the currentValue property for the sound setting.

  • "" - Type information is unavailable.
  • "booleanTarget" - A Boolean type containing only two values. For example: "off" and "on", or "false" and "true".
  • "doubleNumberTarget" - A number type, including floating point numbers. For example: "1.5", "-10.0".
  • "enumTarget" - An enumeration type containing a finite set of values. For example: "high", "mid", "low".
  • "integerTarget" - An integer type. For example: "1", "-10".
  • "stringTarget" - A string type. For example: "hello".

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "candidate":[
     {
      "isAvailable":true,
      "value":"downmixPcm"
     },
     {
      "isAvailable":true,
      "value":"aac"
     }
    ],
    "currentValue":"downmixPcm",
    "target":"aac"
   }
  ]
 ],
 "id":73
}

getSourceList (v1.2)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

This API provides the list of sources information under the scheme.

getSchemeList (v1.0)

This API provides the list of schemes that device can handle.

getCurrentExternalTerminalsStatus (v1.0)

Gets information about the current status of all external input and output terminal sources of the device.

Request

Format description

{
 "id":"integer",
 "method":"getSourceList",
 "params":[
  {
   "scheme":"string"
  }
 ],
 "version":"v1.2"
}

params Elements

scheme
type

string

multiplicity

1

Scheme name. Refer to here to know scheme and URI structure in detail.

Examples

{
 "method":"getSourceList",
 "id":26,
 "params":[
  {
   "scheme":"radio"
  }
 ],
 "version":"1.2"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "iconUrl":"string",
    "isBrowsable":"boolean",
    "isPlayable":"boolean",
    "meta":"string",
    "outputs":"[string]",
    "playAction":"string",
    "protocols":"[string]",
    "source":"string",
    "title":"string",
    "upnpOperationInfo":{
     "containerID":"string",
     "uuid":"string"
    }
   }
  ]
 ]
}

result Elements

iconUrl
default

""

multiplicity

?

type

string

Icon url of server. Default value is "" and in case server device can not send this parameter, empty string is returned.

isBrowsable
default

false

multiplicity

?

type

boolean

Indicates whether the device can browse the source.

isPlayable
default

false

multiplicity

?

type

boolean

The status if a device can use this source by v1_2.setPlayContent .

meta
default

""

multiplicity

?

type

string

Meta information of a source. For example, this is used for giving a hint to application which icon to show for user. The type is indicated by "meta" URI format and implies that the developers of client side should prepare some actual images with respect to the meta URI. Following meta URIs are defined.

  • "meta:storage:cd" - Audio CD
  • "meta:radio:fm" - FM Radio
  • "meta:radio:am" - AM Radio
  • "meta:radio:dab" - DAB Radio
  • "meta:dlna:music" - DLNA
  • "meta:usb1" - USB1
  • "meta:usb2" - USB2
  • "meta:usbdac" - USB DAC
  • "meta:storage:usb:iPhone" - iPhone
  • "meta:line" - AUX input
  • "meta:usbDac" - USB DAC input
  • "meta:sacd-cd" - SACD/CD input
  • "meta:bd-dvd" - BD/DVD input
  • "meta;game" - GAME input
  • "meta:sat-catv" - SAT/CATV input
  • "meta:video" - VIDEO input
  • "meta:tv" - TV input
  • "meta:hdmi" - HDMI input
  • "meta:btaudio" - BT AUDIO input
  • "meta:coaxial" - Coaxial digital audio input
  • "meta:optical" - Optical digital audio input
  • "meta:source" - Source input
  • "" - no meta info.

outputs
default

null

multiplicity

?

type

string-array

Output terminals that this source can be output are set by URI. URI of output terminal can be retrieved by v1_0.getCurrentExternalTerminalsStatus . Refer to here to know source and URI structure in detail.

playAction
default

""

multiplicity

?

type

string

The action of a device when this uri is set with v1_2.setPlayContent .

  • "startPlay" - A device starts playback.
  • "changeSource" - A device changes the internal state in advance to play back or browse a content such as CD, USB, Radio, HDMI input etc.
  • "unknown" - Action is unknown.
  • "" - No action information

protocols
default

null

multiplicity

?

type

string-array

Array of supported protocols for each source.

  • "scalar" - Audio Control API protocol is supported.
  • "upnp" - UPnP protocol is supported.
  • null - no protocol information

source
multiplicity

1

type

string

Source name composed by URI with scheme and path. Refer to here to know source and URI structure in detail.

title
default

""

multiplicity

?

type

string

Name of source for UI display purpose.

upnpOperationInfo
default

null

multiplicity

?

type

(object)

Information of server that is operated by UPnP for this source. When "upnp" is set in protocols parameter, this may be set. null means no information.

upnpOperationInfo.containerID
default

null

multiplicity

?

type

string

ID of container, which corresponds to this source, in server that is operated by UPnP. null means no container information.

upnpOperationInfo.uuid
multiplicity

1

type

string

Unique ID of server that is operated by UPnP for this source. This is UUID which UPnP device has.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "outputs":[
     "extOutput:zone?zone=1",
     "extOutput:zone?zone=2",
     "extOutput:zone?zone=3"
    ],
    "isPlayable":true,
    "playAction":"startPlay",
    "meta":"meta:radio:fm",
    "isBrowsable":true,
    "source":"radio:fm",
    "iconUrl":"",
    "title":"FM",
    "protocols":[
     "scalar"
    ]
   }
  ]
 ],
 "id":26
}

getSupportedApiInfo (v1.0)

Lib

guide

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

This API provides supported services and its information. This API is used in the initialization sequence to dynamically fetch the service compatibility of server.

Request

Format description

{
 "id":"integer",
 "method":"getSupportedApiInfo",
 "params":[
  {
   "services":"[string]"
  }
 ],
 "version":"v1.0"
}

params Elements

services
type

string-array

multiplicity

?

default

null

Services to fetch API information. null or empty array is treated as all services.

Examples

{
 "method":"getSupportedApiInfo",
 "id":5,
 "params":[
  {
   "services":[
    "system",
    "avContent"
   ]
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "apis":[
     {
      "name":"string",
      "versions":[
       {
        "authLevel":"string",
        "protocols":"[string]",
        "version":"string"
       }
      ]
     }
    ],
    "notifications":[
     {
      "name":"string",
      "versions":[
       {
        "authLevel":"string",
        "version":"string"
       }
      ]
     }
    ],
    "protocols":"[string]",
    "service":"string"
   }
  ]
 ]
}

result Elements

apis
multiplicity

1

type

(object-array)

Supported APIs.

apis.name
multiplicity

1

type

string

Name of this API.

apis.versions
multiplicity

1

type

(object-array)

Detail of supported versions of this API.

apis.versions.authLevel
default

"none"

multiplicity

?

type

string

Authentication level of this API.

apis.versions.protocols
default

null

multiplicity

?

type

string-array

Transport for this API, if there are any exception from that of belonging service.

apis.versions.version
multiplicity

1

type

string

Version of this API.

notifications
default

null

multiplicity

?

type

(object-array)

Supported Notification APIs.

notifications.name
multiplicity

1

type

string

Name of this API.

notifications.versions
multiplicity

1

type

(object-array)

Detail of supported versions of this API.

notifications.versions.authLevel
default

"none"

multiplicity

?

type

string

Authentication level of this API.

notifications.versions.version
multiplicity

1

type

string

Version of this API.

protocols
multiplicity

1

type

string-array

Supported transports.

service
multiplicity

1

type

string

Name of this service.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "apis":[
     {
      "versions":[
       {
        "version":"1.0"
       }
      ],
      "name":"actRegister"
     }
    ],
    "service":"accessControl",
    "protocols":[
     "xhrpost:jsonizer"
    ],
    "notifications":[]
   },
   {
    "apis":[
     {
      "versions":[
       {
        "version":"1.0"
       }
      ],
      "name":"enableSampleNotification"
     },
     {
      "versions":[
       {
        "version":"1.0"
       }
      ],
      "name":"echo"
     }
    ],
    "service":"sample",
    "protocols":[
     "websocket:jsonizer"
    ],
    "notifications":[
     {
      "versions":[
       {
        "authLevel":"none",
        "version":"1.0"
       }
      ],
      "name":"notifySample"
     }
    ]
   }
  ]
 ],
 "id":5
}

getSystemInformation (v1.4)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets general system information for the device.

Request

Format description

{
 "id":"integer",
 "method":"getSystemInformation",
 "params":[],
 "version":"v1.4"
}

Examples

{
 "method":"getSystemInformation",
 "id":65,
 "params":[],
 "version":"1.4"
}

Response

Format description

{
 "id":"integer",
 "result":[
  {
   "area":"string",
   "bdAddr":"string",
   "bleID":"string",
   "cid":"string",
   "deviceID":"string",
   "duid":"string",
   "esn":"string",
   "generation":"string",
   "helpUrl":"string",
   "iconUrl":"string",
   "initialPowerOnTime":"string",
   "language":"string",
   "lastPowerOnTime":"string",
   "macAddr":"string",
   "model":"string",
   "name":"string",
   "product":"string",
   "region":"string",
   "serial":"string",
   "ssid":"string",
   "version":"string",
   "wirelessMacAddr":"string"
  }
 ]
}

result Elements

area
default

""

multiplicity

?

type

string

The country code for the device, as a ISO 3166-1 alpha-3 three-letter country code, or "" if it is undefined.

bdAddr
default

""

multiplicity

?

type

string

The Bluetooth address of the device.

bleID
default

""

multiplicity

?

type

string

The Bluetooth Low Energy ID for the device, or "" if it is not available. This is a 32 bit hash value generated from the Bluetooth address.

cid
default

""

multiplicity

?

type

string

The server device ID for associating system log data to this device, or "" if it is undefined.

deviceID
default

""

multiplicity

?

type

string

The general device ID for the device, or "" it if is not available.

duid
default

""

multiplicity

?

type

string

The support DUID (DHCP Unique Identifier) for the device, or "" it if is not available. A client can use the DUID to get an IP address from a DHCPv6 server.

esn
default

""

multiplicity

?

type

string

Model name (10 joists) and ID (22 joists) for Netflix.

generation
default

""

multiplicity

?

type

string

The generation number of the device, represented as an X.Y.Z value, where X, Y, and Z are strings composed of letter and number characters; or "" if it is undefined.

helpUrl
default

""

multiplicity

?

type

string

The help URL for the device, or "" it if is undefined.

iconUrl
default

""

multiplicity

?

type

string

The icon URL of the service for the device, or "" if it is undefined.

initialPowerOnTime
default

""

multiplicity

?

type

string

The initial power-on time for the device, in ISO8601 format, or "" if it is not available.

language
default

""

multiplicity

?

type

string

The language code for the device, as a ISO 3166-1 alpha-3 three-letter country code, or "" if it is undefined.

lastPowerOnTime
default

""

multiplicity

?

type

string

The last power-on time for the device, in ISO8601 format, or "" if it is not available.

macAddr
default

""

multiplicity

?

type

string

The Ethernet MAC address of the device, or "" if it is not available.

model
default

""

multiplicity

?

type

string

The unique name of the product model, or "" if it is undefined.

name
default

""

multiplicity

?

type

string

The product name for the device, or "" if it is not available.

product
default

""

multiplicity

?

type

string

The device category, or "" if it is undefined.

  • "" - Undefined.
  • "TV" - Television.

region
default

""

multiplicity

?

type

string

The sales region for the device, as a ISO 3166-1 alpha-3 three-letter country code, or "" if it is undefined.

serial
default

""

multiplicity

?

type

string

The serial number of the device, or "" if it is not available.

ssid
default

""

multiplicity

?

type

string

The network SSID of the access point to which the device is connected, or "" if it is undefined.

version
default

""

multiplicity

?

type

string

Version information for the device, or "" it if is not available.

wirelessMacAddr
default

""

multiplicity

?

type

string

The wireless MAC address for the device, or "" if it is undefined.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  {
   "esn":"SONY-16BDP50012O1TRFL280BFAVWE",
   "wirelessMacAddr":"ec:0e:c4:18:49:07",
   "deviceID":"B0:00:03:08:9E:98",
   "version":"M30.R.0095",
   "lastPowerOnTime":"2016-07-28T10:00:00Z",
   "initialPowerOnTime":"2016-05-10T13:00:00Z",
   "macAddr":"fc:f1:52:7b:99:df"
  }
 ],
 "id":65
}

getVolumeInformation (v1.1)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Gets the current volume level and mute status.

setAudioMute (v1.1)

Sets the audio mute status.

setAudioVolume (v1.1)

Sets the audio volume level.

notifyVolumeInformation (v1.0)

The notification sent by a device when its volume information or mute status changes.

Request

Format description

{
 "id":"integer",
 "method":"getVolumeInformation",
 "params":[
  {
   "output":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

output
type

string

multiplicity

?

default

""

The URI of the output. Omit this field or use "" to affect all outputs for the device. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"getVolumeInformation",
 "id":33,
 "params":[
  {
   "output":"extOutput:zone?zone=2"
  }
 ],
 "version":"1.1"
}

Response

Format description

{
 "id":"integer",
 "result":[
  [
   {
    "maxVolume":"integer",
    "minVolume":"integer",
    "mute":"string",
    "output":"string",
    "step":"integer",
    "volume":"integer"
   }
  ]
 ]
}

result Elements

maxVolume
default

-1

multiplicity

?

type

integer

The maximum volume level of the output; or -1 if no maximum value is available or if the device does not support setting the volume by an absolute value.

minVolume
default

-1

multiplicity

?

type

integer

The minimum volume level of the output; or -1 if no minimum value is available or if the device does not support setting the volume by an absolute value.

mute
default

""

multiplicity

?

type

string

The current mute status of the output.

  • "" - The device does not support mute.
  • "off" - Not muted.
  • "on" - Muted.
  • "toggle" - Unknown; the device can only toggle the mute setting.

output
default

""

multiplicity

?

type

string

The URI of the output. For more information about the URI structure, see the Device Resource URI page. "" refers to all outputs of the device.

step
default

0

multiplicity

?

type

integer

The volume level step value for the output; or 0 if the device only supports setting the volume by an absolute value.

volume
default

-1

multiplicity

?

type

integer

The current volume level of the output; or -1 if no volume information is available or if the device does not support setting the volume by an absolute value.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  [
   {
    "volume":25,
    "minVolume":0,
    "mute":"off",
    "step":1,
    "maxVolume":74
   }
  ]
 ],
 "id":33
}

notifyPlayingContentInfo (v1.0)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

The notification sent by a device when its playing content or active input changes. To subscribe to or unsubscribe from specific notifications, use the commonapi.v1_0.SwitchNotifications method. To manually get the playing content, use the v1_2.getPlayingContentInfo method.

getPlayingContentInfo (v1.2)

Gets information about the playing content or current selected input.

switchNotifications (v1.0)

Subscribes and unsubscribes to multiple notifications at a time.

Notification

Format description

When source is cast:audio
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "applicationName":"string",
   "source":"cast:audio",
   "title":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}
When source is netService:audio
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "albumName":"string",
   "artist":"string",
   "contentKind":"string",
   "output":"string",
   "source":"netService:audio",
   "stateInfo":{
    "state":"string"
   },
   "title":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}
When source is extInput:*
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "contentKind":"string",
   "output":"string",
   "source":"extInput:*",
   "title":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}
When source is radio:*
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "broadcastFreq":"integer",
   "broadcastFreqBand":"string",
   "channelName":"string",
   "contentKind":"string",
   "dabInfo":{
    "componentLabel":"string",
    "dynamicLabel":"string",
    "ensembleLabel":"string",
    "serviceLabel":"string"
   },
   "fileNo":"string",
   "output":"string",
   "parentUri":"string",
   "source":"radio:*",
   "stateInfo":{
    "state":"string",
    "supplement":"string"
   },
   "title":"string",
   "totalCount":"integer",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}
When source is storage:*
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "albumName":"string",
   "artist":"string",
   "audioInfo":[
    {
     "channel":"string",
     "codec":"string",
     "frequency":"string"
    }
   ],
   "contentKind":"string",
   "durationMsec":"integer",
   "fileNo":"string",
   "genre":"[string]",
   "index":"integer",
   "output":"string",
   "parentIndex":"integer",
   "parentUri":"string",
   "playlistName":"string",
   "podcastName":"string",
   "positionMsec":"integer",
   "source":"storage:*",
   "sourceLabel":"string",
   "stateInfo":{
    "state":"string",
    "supplement":"string"
   },
   "title":"string",
   "totalCount":"integer",
   "uri":"string",
   "videoInfo":{
    "codec":"string"
   }
  }
 ],
 "version":"v1.0"
}
When source is dlna:*
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "contentKind":"string",
   "durationMsec":"integer",
   "mediaType":"string",
   "output":"string",
   "playSpeed":"string",
   "playSpeedStep":"integer",
   "positionMsec":"integer",
   "repeatType":"string",
   "source":"dlna:*",
   "title":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

albumName
type

string

multiplicity

?

default

null

The Album name for the content, or null or omitted if no album name is defined.

applicationName
type

string

multiplicity

?

default

null

The name of the application that is playing the content, or null or omitted if it is undefined. If the content is streaming via the Cast for Audio service, the name of the casted application is used.

artist
type

string

multiplicity

?

default

null

The artist's name, or null or omitted if no artist name is defined.

audioInfo
type

(object-array)

multiplicity

?

default

null

Audio information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

audioInfo.channel
type

string

multiplicity

?

default

""

The number of audio channels.

audioInfo.codec
type

string

multiplicity

?

default

""

The audio codec for the content.

  • "" - unknown
  • "aac-lc"
  • "f1-lpcm"
  • "lpcm"

audioInfo.frequency
type

string

multiplicity

?

default

""

The sampling audio frequency in Hz, or "" if it is unavailable.

  • (ex) "44100"
  • (ex) "88200"
  • (ex) "96000"

broadcastFreq
type

integer

multiplicity

?

default

-1

The broadcast frequency for the content, in Hz.

broadcastFreqBand
type

string

multiplicity

?

default

""

The broadcast frequency band for the content.

  • "" - No band data
  • "am" - AM
  • "fm" - FM
  • "lw" - LW
  • "mw" - MW
  • "sw" - SW

channelName
type

string

multiplicity

?

default

null

The name of the broadcast channel, or null if it is undefined.

contentKind
type

string

multiplicity

?

default

""

Identifies the content type.

  • "" - Unknown
  • "directory" - Directory
  • "input" - External input
  • "movie" - Movie
  • "movie_avi" - AVI movie
  • "movie_mp4" - MP4 movie
  • "movie_xavcs" - XAVC S movie
  • "music" - Music
  • "radio" - Radio
  • "service" - Network service
  • "still" - Still image
  • "still_group" - Still group

dabInfo
type

(object)

multiplicity

?

default

null

Digital Audio Broadcasting ( DAB ) information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

dabInfo.componentLabel
type

string

multiplicity

?

default

null

The component label, for a service which carries either audio or data, or null or omitted if not available.

  • (ex) "BBC Asian Network"

dabInfo.dynamicLabel
type

string

multiplicity

?

default

null

The dynamic label, such as song title or text information of advertisement, or null or omitted if not available.

dabInfo.ensembleLabel
type

string

multiplicity

?

default

null

The ensemble label, which identifies an ensemble in a textual format, or null or omitted if not available.

  • (ex) "BBC National DAB"

dabInfo.serviceLabel
type

string

multiplicity

?

default

null

The service label, which identifies a service in a textual format, or null or omitted if not available.

  • (ex) "BBC Asian Network"

durationMsec
type

integer

multiplicity

?

default

-1

The length of the content, in milliseconds, or -1 if it is undefined.

fileNo
type

string

multiplicity

?

default

""

The file number of the content. What a file represents depends on the content type, such as a track or a broadcast preset item.

genre
type

string-array

multiplicity

?

default

null

The genres assigned to the content, or null or omitted if no genres are assigned. This is used for display purpose and is device-dependent.

index
type

integer

multiplicity

?

default

0

The index of the content list.

mediaType
type

string

multiplicity

?

default

""

The media type of the playing content.

  • "" - unknown type
  • "audio" - audio(music) content
  • "image" - image(photo) content
  • "video" - video content

output
type

string

multiplicity

?

default

""

The URI of the output terminal on which the content is playing. To get information about the current status of all external output terminal sources of the device, see the v1_0.getCurrentExternalTerminalsStatus method. For more information about the URI structure, see the Device Resource URI page.

parentIndex
type

integer

multiplicity

?

default

0

The index of the parent directory.

parentUri
type

string

multiplicity

?

default

""

The URI of the parent directory if the source is browsable; otherwise "".

playSpeed
type

string

multiplicity

?

default

"1.0"

The current play speed, expressed as a number with one decimal place.

  • (ex) "1.0"
  • (ex) "1.5"

playSpeedStep
type

integer

multiplicity

?

default

0

The playback speed setting of the content. Positive numbers represent fast-forward settings, with greater numbers representing faster speeds. Negative numbers represent slow-motion settings, with lesser numbers representing slower speeds. The playback speed for each setting is device dependent.

  • 3 - Fast forward
  • 2 - Fast forward
  • 1 - Fast forward
  • 0 - Normal speed
  • -1 - Slow motion
  • -2 - Slow motion
  • -3 - Slow motion

playlistName
type

string

multiplicity

?

default

null

The name of the playlist in which the content is included, or null or omitted if no playlist is defined.

podcastName
type

string

multiplicity

?

default

null

The name of the podcast, or null or omitted if this content is not from a podcast.

positionMsec
type

integer

multiplicity

?

default

0

The playing position within the content, in milliseconds.

repeatType
type

string

multiplicity

?

default

"off"

The repeat setting for the current content.

  • "off" - Repeat playback disabled for the single unit of content currently playing.
  • "on" - Repeat playback enabled for the single unit of content currently playing.

source
type

string

multiplicity

?

default

""

The source of the playing content, described by the base URI of the content, or "" if it is undefined.

sourceLabel
type

string

multiplicity

?

default

null

The display name of the source of the playing content, or null if it is undefined.

stateInfo
type

(object)

multiplicity

?

default

null

The playback status of the device. If a value for this field is included in the notification, at least one of its fields will contain a value.

stateInfo.state
type

string

multiplicity

1

Playing status

  • "PLAYING" - Content is being played
  • "STOPPED" - Content is stopped
  • "PAUSED" - Content is pausing
  • "FORWARDING" - Content is being forwarded.

stateInfo.supplement
type

string

multiplicity

?

default

null

Supplemental information about the playback status the device.

  • null - No supplemental information.
  • "alarmInterrupting" - Interrupting and switching to Emergency Warning System.
  • "automaticMusicScanning" - Changing to next content by AMS (Automatic Music Scan) function.
  • "autoPresetting" - Presetting broadcast stations automatically.
  • "autoScanning" - Scanning for DAB digital radio automatically.
  • "bwdSeeking" - Backward seeking broadcast stations.
  • "enumerating" - Enumerating storage device.
  • "fwdSeeking" - Forward seeking broadcast stations.
  • "initialScanning" - Initial scanning for DAB digital radio.
  • "loading" - Loading a disc storage device.
  • "manualSeeking" - Seeking broadcast stations manually.
  • "noContent" - There is no content that can be played back.
  • "noMedia" - There is no media.
  • "noNextContent" - There is no next content in current playback scope.
  • "noPreviousContent" - There is no previous content in current playback scope.
  • "notAvailable" - A device can not play back for some reason.
  • "presetMemorizing" - Memorizing preset of broadcast station.
  • "reading" - Reading a structure of storage device.
  • "receiving" - Receiving DAB digital radio. (Before initial scan of DAB etc.)
  • "uncontrollable" - This content can not be controlled such as pause, stop, or scan by pausePlayingContent, stopPlayingContent, setPlaySpeed, or scanPlayingContent, and so on.

title
type

string

multiplicity

?

default

null

The display title of the playing content, or null if it is undefined.

  • (ex) "My Movie"

totalCount
type

integer

multiplicity

?

default

-1

The number of content items in the playback scope, or -1 if it is unknown.

uri
type

string

multiplicity

1

The full URI of the playing content. For more information about the URI structure, see the Device Resource URI page.

videoInfo
type

(object)

multiplicity

?

default

null

Video information for the playing content. If a value for this field is included in the notification, at least one of its fields will contain a value.

videoInfo.codec
type

string

multiplicity

?

default

""

The video codec for the content.

  • "" - unknown
  • "avc" - MPEG4 AVC
  • "mpeg1" - MPEG1 VIDEO
  • "mpeg2" - MPEG2 VIDEO
  • "mpeg4" - MPEG4 VIDEO
  • "vc1" - VC1
  • "wmv" - WMV
  • "xvid" - Xvid

Examples

Example of audio content.
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "output":"extOutput:zone?zone=1",
   "albumName":"THE BEATLES disc1",
   "contentKind":"music",
   "parentUri":"storage:usb1?path=/music",
   "artist":"The Beatles",
   "durationMsec":167000,
   "positionMsec":4000,
   "stateInfo":{
    "state":"PLAYING"
   },
   "source":"storage:usb1",
   "title":"NOWHERE MAN",
   "uri":"storage:usb1?path=/music/07%20NOWHERE%20MAN.wma"
  }
 ],
 "version":"1.0"
}
Example of radio content.
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "output":"extOutput:zone?zone=1",
   "contentKind":"radio",
   "parentUri":"radio:fm",
   "broadcastFreqBand":"fm",
   "fileNo":"0",
   "broadcastFreq":85900000,
   "stateInfo":{
    "state":"PLAYING"
   },
   "source":"radio:fm",
   "title":"",
   "totalCount":30,
   "uri":"radio:fm?contentId=0"
  }
 ],
 "version":"1.0"
}
Example of External input content.
{
 "method":"notifyPlayingContentInfo",
 "params":[
  {
   "output":"extOutput:zone?zone=1",
   "contentKind":"input",
   "source":"extInput:tv",
   "uri":"extInput:tv"
  }
 ],
 "version":"1.0"
}

notifyPowerStatus (v1.0)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

The notification sent by a device when its power status changes. To subscribe to or unsubscribe from specific notifications, use the commonapi.v1_0.SwitchNotifications method. To manually get the current power status, use the v1_1.getPowerStatus method.

getPowerStatus (v1.1)

Gets the current power status of the device.

setPowerStatus (v1.1)

Sets the power status of the device.

Notification

Format description

{
 "method":"notifyPowerStatus",
 "params":[
  {
   "standbyDetail":"string",
   "status":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

standbyDetail
type

string

multiplicity

?

default

""

Additional information for the standby power state. If this value is omitted or "", then no additional information is available.

status
type

string

multiplicity

1

The current power status of the device.

  • "active" - The device is in the power-on state.
  • "standby" - The device is in the standby state. Network functions are active, and the device can switch to the power-on state via a network command.
  • "shuttingDown" - The device is switching to the power-off state.

Examples

{
 "method":"notifyPowerStatus",
 "params":[
  {
   "status":"shuttingDown"
  }
 ],
 "version":"1.0"
}

notifySWUpdateInfo (v1.0)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

The notification sent by a device when firmware updates are available. The service periodically checks for updates and sends a notification when an update is available. To subscribe to or unsubscribe from specific notifications, use the commonapi.v1_0.SwitchNotifications method. To manually check for updates, use the v1_0.getSWUpdateInfo method.

getSWUpdateInfo (v1.0)

Checks whether firmware updates are available for the device.

switchNotifications (v1.0)

Subscribes and unsubscribes to multiple notifications at a time.

Notification

Format description

{
 "method":"notifySWUpdateInfo",
 "params":[
  {
   "isUpdatable":"string",
   "swInfo":[
    {
     "estimatedTimeSec":"integer",
     "forcedUpdate":"string",
     "target":"string",
     "updatableVersion":"string"
    }
   ]
  }
 ],
 "version":"v1.0"
}

params Elements

isUpdatable
type

string

multiplicity

1

Indicates whether an update is available.

  • "true" - A firmware update is available for the device.
  • "false" - A firmware update is not available for the device.

swInfo
type

(object-array)

multiplicity

?

default

null

An array of the available updates. Note that this API does not currently provide a way to update the software. For information on how to update the software, see the manual for the device.

swInfo.estimatedTimeSec
type

integer

multiplicity

?

default

-1

The estimated time required to update the application, in seconds; or -1 if the time is unknown.

swInfo.forcedUpdate
type

string

multiplicity

?

default

"false"

Indicates whether a forced update is required.

  • "true" - A forced update is required.
  • "false" - A forced update is not required.

swInfo.target
type

string

multiplicity

?

default

""

The application to which this update applies.

swInfo.updatableVersion
type

string

multiplicity

1

The version the application will be after the update.

Examples

{
 "method":"notifySWUpdateInfo",
 "params":[
  {
   "isUpdatable":"true",
   "swInfo":[
    {
     "estimatedTimeSec":300,
     "updatableVersion":"M29.R.0250"
    }
   ]
  }
 ],
 "version":"1.0"
}

notifyVolumeInformation (v1.0)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

The notification sent by a device when its volume information or mute status changes. To subscribe to or unsubscribe from specific notifications, use the commonapi.v1_0.SwitchNotifications method. To manually get the volume information and mute status, use the v1_1.getVolumeInformation method.

getVolumeInformation (v1.1)

Gets the current volume level and mute status.

setAudioMute (v1.1)

Sets the audio mute status.

setAudioVolume (v1.1)

Sets the audio volume level.

switchNotifications (v1.0)

Subscribes and unsubscribes to multiple notifications at a time.

Notification

Format description

{
 "method":"notifyVolumeInformation",
 "params":[
  {
   "mute":"string",
   "output":"string",
   "volume":"integer"
  }
 ],
 "version":"v1.0"
}

params Elements

mute
type

string

multiplicity

?

default

""

The current mute status of the output.

  • "" - The device does not support mute.
  • "off" - Not muted.
  • "on" - Muted.
  • "toggle" - Unknown; the device can only toggle the mute setting.

output
type

string

multiplicity

?

default

""

The URI of the output. For more information about the URI structure, see the Device Resource URI page. "" refers to all outputs of the device.

  • (ex) "extOutput:zone?zone=2"

volume
type

integer

multiplicity

?

default

-1

The current volume level of the output; or -1 if no volume information is available or if the device does not support setting the volume by an absolute value.

Examples

{
 "method":"notifyVolumeInformation",
 "params":[
  {
   "volume":20,
   "output":"extOutput:zone?zone=2",
   "mute":"off"
  }
 ],
 "version":"1.0"
}

pausePlayingContent (v1.1)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Toggles between the play and pause states for the current content. In the pause state, playback is suspended temporarily and can be restarted quickly.

setPlayContent (v1.2)

Sets the playing content or changes the active input.

stopPlayingContent (v1.1)

Stops the currently playing content.

getPlayingContentInfo (v1.2)

Gets information about the playing content or current selected input.

Request

Format description

{
 "id":"integer",
 "method":"pausePlayingContent",
 "params":[
  {
   "output":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

output
type

string

multiplicity

?

default

""

The URI of the output. Omit this field or use "" to affect all outputs for the device. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"pausePlayingContent",
 "id":31,
 "params":[
  {
   "output":"extOutput:zone?zone=1"
  }
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":31
}

presetBroadcastStation (v1.0)

Lib

avContent

Supported by

STR-DN1080

Description

Sets a preset broadcast station for a device which has tuner function, such as a TV or radio.

seekBroadcastStation (v1.0)

Seeks broadcast content on a device with a tuner.

Request

Format description

{
 "id":"integer",
 "method":"presetBroadcastStation",
 "params":[
  {
   "frequency":"integer",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

frequency
type

integer

multiplicity

?

default

-1

The frequency (Hz) of the broadcast station to assign to the preset. To use the service default for this preset ID, omit this parameter or set it to -1.

uri
type

string

multiplicity

1

The URI for which to preset content. Provide the numeric ID for the preset in the contentId query portion of the URI.

  • (ex) "radio:fm?contentId=1"

Examples

{
 "method":"presetBroadcastStation",
 "id":58,
 "params":[
  {
   "uri":"radio:fm?contentId=1",
   "frequency":79500000
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":58
}

scanPlayingContent (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Scans content. Content is previewed for a short period of time; The scan duration and speed are device dependent. The device responds as if the user pressed the FWD or BWD scan button on the device.

Request

Format description

{
 "id":"integer",
 "method":"scanPlayingContent",
 "params":[
  {
   "direction":"string",
   "output":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

direction
type

string

multiplicity

1

The scan direction.

  • "bwd" - Scan backwards
  • "fwd" - Scan forwards

output
type

string

multiplicity

?

default

""

The URI of the output to scan. For more information about the URI structure, see the Device Resource URI page. If this is skipped or "" is set, it means all outputs.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"scanPlayingContent",
 "id":62,
 "params":[
  {
   "direction":"fwd"
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":62
}

seekBroadcastStation (v1.0)

Lib

avContent

Supported by

STR-DN1080

Description

Seeks broadcast content on a device with a tuner. After a station is found, you can use the v1_2.getPlayingContentInfo method to get information about the playing content. When auto seek is used, the device scans until it receives a station. When manual seek is used on a radio tuner, the amount by which the frequency is stepped is device dependent.

presetBroadcastStation (v1.0)

Sets a preset broadcast station for a device which has tuner function, such as a TV or radio.

getPlayingContentInfo (v1.2)

Gets information about the playing content or current selected input.

Request

Format description

{
 "id":"integer",
 "method":"seekBroadcastStation",
 "params":[
  {
   "direction":"string",
   "tuning":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

direction
type

string

multiplicity

1

The seek direction.

  • "bwd" - Seek backwards.
  • "fwd" - Seek forwards.

tuning
type

string

multiplicity

?

default

"manual"

The tuning method.

  • "auto" - Auto seek.
  • "manual" - Manual seek.

Examples

{
 "method":"seekBroadcastStation",
 "id":24,
 "params":[
  {
   "tuning":"manual",
   "direction":"bwd"
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":24
}

setActiveTerminal (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Activates or deactivates an input or output terminal. This API can change the power status of zone output. To get the current power status of zone output, use the v1_0.GetCurrentExternalTerminalsStatus method or subscribe to the v1_0.NotifyPlayingContentInfo notification.

getCurrentExternalTerminalsStatus (v1.0)

Gets information about the current status of all external input and output terminal sources of the device.

notifyPlayingContentInfo (v1.0)

The notification sent by a device when its playing content or active input changes.

Request

Format description

{
 "id":"integer",
 "method":"setActiveTerminal",
 "params":[
  {
   "active":"string",
   "uri":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

active
type

string

multiplicity

1

Indicates whether to activate or deactivate the terminal.

  • "active" - Activate the terminal.
  • "inactive" - Deactivate the terminal.

uri
type

string

multiplicity

1

The URI of the input or output terminal to activate or deactivate. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"setActiveTerminal",
 "id":13,
 "params":[
  {
   "active":"active",
   "uri":"extOutput:zone?zone=3"
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":13
}

setAudioMute (v1.1)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Sets the audio mute status.

getVolumeInformation (v1.1)

Gets the current volume level and mute status.

setAudioVolume (v1.1)

Sets the audio volume level.

notifyVolumeInformation (v1.0)

The notification sent by a device when its volume information or mute status changes.

Request

Format description

{
 "id":"integer",
 "method":"setAudioMute",
 "params":[
  {
   "mute":"string",
   "output":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

mute
type

string

multiplicity

1

The mute status to set or adjustment to make. Use the getVolumeInformation method to determine whether the device uses on/off or toggle settings for this output.

  • "off" - Not muted.
  • "on" - Muted.
  • "toggle" - Toggle the mute setting.

output
type

string

multiplicity

?

default

""

The URI of the output. For more information about the URI structure, see the Device Resource URI page. Omit this field or use "" to affect all outputs for the device.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"setAudioMute",
 "id":601,
 "params":[
  {
   "mute":"on"
  }
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":601
}

setAudioVolume (v1.1)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Sets the audio volume level.

getVolumeInformation (v1.1)

Gets the current volume level and mute status.

setAudioMute (v1.1)

Sets the audio mute status.

notifyVolumeInformation (v1.0)

The notification sent by a device when its volume information or mute status changes.

Request

Format description

{
 "id":"integer",
 "method":"setAudioVolume",
 "params":[
  {
   "output":"string",
   "volume":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

output
type

string

multiplicity

?

default

""

The URI of the output. For more information about the URI structure, see the Device Resource URI page. Omit this field or use "" to affect all outputs for the device.

  • (ex) "extOutput:zone?zone=2"

volume
type

string

multiplicity

1

The volume level to set or adjustment to make. Use the getVolumeInformation method to determine whether the device uses absolute or relative values for this output.

  • "N" - Set the volume level to N, where N is an integer, for example, "25".
  • "+N" - Increase the volume level by N, where N is an integer, for example, "+14".
  • "-N" - Decrease the volume level by N, where N is an integer, for example, "-10".

Examples

{
 "method":"setAudioVolume",
 "id":98,
 "params":[
  {
   "volume":"5",
   "output":"extOutput:zone?zone=2"
  }
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

40800

The target is not supported or can not be controlled for some device specific reason.

40801

The volume is out of range.

Examples

{
 "result":[],
 "id":98
}

setCustomEqualizerSettings (v1.0)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080

Description

Sets custom equalizer settings. Not all settings are valid for all products. Use the v1_0.getCustomEqualizerSettings method to get the valid settings for the current product.

getCustomEqualizerSettings (v1.0)

Gets information about the current custom equalizer settings.

Request

Format description

{
 "id":"integer",
 "method":"setCustomEqualizerSettings",
 "params":[
  {
   "settings":[
    {
     "target":"string",
     "value":"string"
    }
   ]
  }
 ],
 "version":"v1.0"
}

params Elements

settings
type

(object-array)

multiplicity

1

An array of the settings to apply.

settings.target
type

string

multiplicity

1

The name of the equalizer setting to set.

  • "100HzBandLevel" - The level for the 100 Hz band in the equalizer.
  • "330HzBandLevel" - The level for the 330 Hz band in the equalizer.
  • "1000HzBandLevel" - The level of the 1,000 Hz band in the equalizer.
  • "3300HzBandLevel" - The level of the 3,300 Hz band in the equalizer.
  • "10000HzBandLevel" - The level of the 10,000 Hz band in the equalizer.
  • "frontBassLevel" - The level of the front bass in the equalizer.
  • "frontTrebleLevel" - The level of the front treble in the equalizer.
  • "centerBassLevel" - The level of the center bass in the equalizer.
  • "centerTrebleLevel" - The level of the center treble in the equalizer.
  • "surroundBassLevel" - The level of the surround bass in the equalizer.
  • "surroundTrebleLevel" - The level of the surround treble in the equalizer.
  • "frontHighBassLevel" - The level of the front high bass in the equalizer.
  • "frontHighTrebleLevel" - The level of the front high treble in the equalizer.
  • "bassLevel" - The level of the bass in the equalizer.
  • "trebleLevel" - The level of the treble in the equalizer.

settings.value
type

string

multiplicity

1

The value to apply to the equalizer setting.

  • In case "target" is "100HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "330HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "1000HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "3300HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "10000HzBandLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "centerBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "centerTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "surroundBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "surroundTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontHighBassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "frontHighTrebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "bassLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.
  • In case "target" is "trebleLevel"
    • -10 - Min value.
    • : (step by 1)
    • 10 - Max value.

Examples

{
 "method":"setCustomEqualizerSettings",
 "id":15,
 "params":[
  {
   "settings":[
    {
     "value":"8",
     "target":"bassLevel"
    }
   ]
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

40004

The service failed to update one or more settings. Call the associated get settings method to identify which settings still need to be updated.

Examples

{
 "result":[],
 "id":15
}

setPlayContent (v1.2)

Lib

avContent

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Sets the playing content or changes the active input. This API can resume playback of content. This API also supports playlists. Some request parameters for changing the play mode; such as positionMSec, resume, repeatType, keepLastFrame, and so on; change volatile settings that affect the current playing state.

stopPlayingContent (v1.1)

Stops the currently playing content.

pausePlayingContent (v1.1)

Toggles between the play and pause states for the current content.

getPlayingContentInfo (v1.2)

Gets information about the playing content or current selected input.

scanPlayingContent (v1.0)

Scans content.

Request

Format description

{
 "id":"integer",
 "method":"setPlayContent",
 "params":[
  {
   "keepLastFrame":"boolean",
   "output":"string",
   "positionMsec":"integer",
   "positionSec":"double",
   "repeatType":"string",
   "requester":"string",
   "resume":"boolean",
   "uri":"string"
  }
 ],
 "version":"v1.2"
}

params Elements

keepLastFrame
type

boolean

multiplicity

?

default

false

Applies only to video content. Indicates whether to keep the last frame when playback stops, such as when the v1_1.stopPlayingContent or v1_1.pausePlayingContent method is called or when the end of the content is reached.

output
type

string

multiplicity

?

default

""

The URI of the output terminal to affect. To get information about the current status of all external output terminal sources of the device, see the v1_0.getCurrentExternalTerminalsStatus method. For more information about the URI structure, see the Device Resource URI page.

positionMsec
type

integer

multiplicity

?

default

-1

The playing position within the content, in milliseconds. The default value, -1, indicates the beginning or last position, depending on the device and service.

positionSec
type

double

multiplicity

?

default

-1

Deprecated for unit consistency with other API. The position to be started by seek operation. Default value is -1. (It means a head of a content or last position. This depends on a server spec.)

repeatType
type

string

multiplicity

?

default

"off"

Indicates whether repeat playback is enabled for the unit of content that is currently playing.

  • "off" - Repeat playback is disabled.
  • "on" - Repeat playback is enabled.

requester
type

string

multiplicity

?

default

"user"

Indicates the originator of the API call. The device may behave differently depending on the originator.

  • "ui" - This method was called in response to the user interacting directly with the device UI.
  • "user" - This method was called in response to some user action.

resume
type

boolean

multiplicity

?

default

false

True to resume play; otherwise, false.

uri
type

string

multiplicity

?

default

""

The URI of the input or source. To resume normal playback from a seek, pause, or stop status, set the URI to null or "". For more information about the URI structure, see the Device Resource URI page. Some devices can switch input or content to the previously selected content by specifying just the scheme or the scheme and source, for example "tv:" or "tv:isdbt" , respectively. For more information about the URIs supported for a given device, see the Supported URIs section of the Home Theater or Personal Audio page under the Device Info menu.

Examples

{
 "method":"setPlayContent",
 "id":47,
 "params":[
  {
   "output":"extOutput:zone?zone=1",
   "uri":"audio:content?path=/music/03%20EIGHT%20DAYS%20A%20WEEK.mp3"
  }
 ],
 "version":"1.2"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

41001

Content does not exist.

41011

Content cannot be played because device is currently recording.

41012

Content cannot be played because the current channel is fixed

Examples

{
 "result":[],
 "id":47
}

setPlayNextContent (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Moves to the next content. The device responds as if the user pressed NEXT on the device.

setPlayPreviousContent (v1.0)

Moves to the previous content.

Request

Format description

{
 "id":"integer",
 "method":"setPlayNextContent",
 "params":[
  {
   "output":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

output
type

string

multiplicity

?

default

""

URI of output. If this is skipped or "" is set, it means all outputs. Refer to here to know URI structure in detail.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"setPlayNextContent",
 "id":17,
 "params":[
  {
   "output":"extOutput:zone?zone=1"
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":17
}

setPlayPreviousContent (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Moves to the previous content. The device responds as if the user pressed PREV on the device. This function is device and service dependent. For sufficiently long content that has been playing for a while, the service may move to the beginning of the current content.

setPlayNextContent (v1.0)

Moves to the next content.

Request

Format description

{
 "id":"integer",
 "method":"setPlayPreviousContent",
 "params":[
  {
   "output":"string"
  }
 ],
 "version":"v1.0"
}

params Elements

output
type

string

multiplicity

?

default

""

URI of output. If this is skipped or "" is set, it means all outputs. Refer to here to know URI structure in detail.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"setPlayPreviousContent",
 "id":82,
 "params":[
  {
   "output":"extOutput:zone?zone=2"
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":82
}

setPlaybackModeSettings (v1.0)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Updates the current playback mode settings.

getPlaybackModeSettings (v1.0)

Get the current playback mode settings.

Request

Format description

{
 "id":"integer",
 "method":"setPlaybackModeSettings",
 "params":[
  {
   "settings":[
    {
     "target":"string",
     "value":"string"
    }
   ]
  }
 ],
 "version":"v1.0"
}

params Elements

settings
type

(object-array)

multiplicity

1

An array of the settings to apply.

settings.target
type

string

multiplicity

1

The name of the setting to update.

  • "playType" - Playback Mode
  • "repeatType" - Repeat type
  • "shuffleType" - Shuffle type.

settings.value
type

string

multiplicity

1

The value to apply to the setting.

  • In case "target" is "playType"
    • "normal" - Normal playback
    • "folder" - Playback enabled for a unit of folder and its subfolder
    • "repeatAll" - In case current composed of multiple parts, repeat playback enabled for whole parts.
    • "repeatFolder" - Repeat playback enabled for a unit of folder and its subfolder.
    • "repeatTrack" - Repeat playback enabled for a unit of track (audio content) or title (video content).
    • "shuffleAll" - In case current composed of multiple parts, shuffle playback enabled for whole parts.
  • In case "target" is "repeatType"
    • "all" - In case current composed of multiple parts, repeat playback enabled for whole parts.
    • "folder" - Repeat playback enabled for a unit of folder and its subfolder.
    • "track" - Repeat playback enabled for a unit of track (audio content) or title (video content).
    • "chapter" - Repeat playback enabled for a unit of chapter.
    • "off" - Repeat playback disabled as a device setting.
  • In case "target" is "shuffleType"
    • "folder" - Shuffle of a unit of folder and its subfolder. of file name.
    • "off" - Shuffle playback disabled as a device setting.

Examples

{
 "method":"setPlaybackModeSettings",
 "id":93,
 "params":[
  {
   "settings":[
    {
     "value":"all",
     "target":"repeatType"
    }
   ]
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

40004

The service failed to update one or more settings. Call the associated get settings method to identify which settings still need to be updated.

Examples

{
 "result":[],
 "id":93
}

setPowerStatus (v1.1)

Lib

system

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Sets the power status of the device. Recommended setup:

  • QuickStart/Network Standby :ON
    • Required to receive commands while in standby mode.
    • EU STR is exception, it doesn't receive commands while in standby. Use WoL to turn on EU STR.
  • Remote Start : ON
    • Required to turn on by WoL.

getPowerStatus (v1.1)

Gets the current power status of the device.

Request

Format description

{
 "id":"integer",
 "method":"setPowerStatus",
 "params":[
  {
   "standbyDetail":"string",
   "status":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

standbyDetail
type

string

multiplicity

?

default

""

Additional information for the standby power state. If this value is omitted or "", then no additional information is available.

status
type

string

multiplicity

1

The current power status of the device, or the status to set.

  • "" - Changes the power status as if the remote power key is pressed. The power status is device and service dependent.
  • "active" - The device is in the power-on state.
  • "off" - The device is in the power-off state.
  • "standby" - The device is in the standby state. Network functions are active, and the device can switch to the power-on state via a network command. Not all products support standby, personalaudio products don't.

Examples

{
 "method":"setPowerStatus",
 "id":55,
 "params":[
  {
   "status":"off"
  }
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":55
}

setSleepTimerSettings (v1.0)

Lib

system

Supported by

STR-DN1080

Description

Sets the sleep timer settings for the device.

getSleepTimerSettings (v1.0)

Gets the sleep timer settings for the device.

Request

Format description

{
 "id":"integer",
 "method":"setSleepTimerSettings",
 "params":[
  {
   "settings":[
    {
     "target":"string",
     "value":"string"
    }
   ]
  }
 ],
 "version":"v1.0"
}

params Elements

settings
type

(object-array)

multiplicity

1

An array of the settings to apply.

settings.target
type

string

multiplicity

1

The name of the setting to get. Not all settings are valid for all products. Use the getSleepTimerSettings method to get the valid settings for the current product.

  • "sleepTimerMin" - The number of minutes after which to automatically turn off.

settings.value
type

string

multiplicity

1

The value to apply to the setting.

  • In case "target" is "sleepTimerMin"
    • "120" - After 120 minutes.
    • "90" - After 90 minutes.
    • "80" - After 80 minutes.
    • "70" - After 70 minutes.
    • "60" - After 60 minutes.
    • "50" - After 50 minutes.
    • "40" - After 40 minutes.
    • "30" - After 30 minutes.
    • "20" - After 20 minutes.
    • "10" - After 10 minutes.
    • "off" - Do not automatically turn off.
    • "" - The current setting is unknown.

Examples

{
 "method":"setSleepTimerSettings",
 "id":60,
 "params":[
  {
   "settings":[
    {
     "value":"off",
     "target":"sleepTimerMin"
    }
   ]
  }
 ],
 "version":"1.0"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

40004

The service failed to update one or more settings. Call the associated get settings method to identify which settings still need to be updated.

Examples

{
 "result":[],
 "id":60
}

setSoundSettings (v1.1)

Lib

audio

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Sets sound settings. Not all settings are valid for all products. Use the v1_1.getSoundSettings method to get the valid settings for the current product.

getSoundSettings (v1.1)

Gets information about the current sound settings.

Request

Format description

{
 "id":"integer",
 "method":"setSoundSettings",
 "params":[
  {
   "settings":[
    {
     "target":"string",
     "value":"string"
    }
   ]
  }
 ],
 "version":"v1.1"
}

params Elements

settings
type

(object-array)

multiplicity

1

An array of the settings to apply.

settings.target
type

string

multiplicity

1

The name of the sound setting to set. Not all settings are valid for all products. Use the v1_1.getSoundSettings method to get the valid settings for the current product.

  • "aac" - The output method for AAC signals.
  • "audioDRC" - The audio dynamic range compression (DRC) setting.
  • "audioPurenessControl" - Set whether changing screen to black to improve sound quality.
  • "audioPurenessControlTmp" - Set temporary whether changing screen to black to improve sound quality.
  • "autoFormatDirect_2ch" - Set Auto Format Direct (A.F.D)/2-channel sound mode
  • "autoGenreSelector" - To provide suitable Sound Field depending on the kind of contents, switch Sound Field automatically according to "Genre Info" on CEC.
  • "avSyncMs" - Set a delay time (ms) of input audio to adjust Audio and Video Sync. Note that the range and step values vary depending on device.
  • "bdMixMode" - The output method for the interactive audio and secondary audio (commentary) when playing a BD that contains such audio.
  • "calibrationType" - Set Calibration type after you have performed the Auto Calibration and saved the settings.
  • "clearAudio" - Clear Audio+ function
  • "convertToDolbyD" - Settings for Dolby Digital Converter Dolby D Compatible Output function which converts DTS source to Dolby Digital by referring EDID
  • "digitalAudioType" - The sound setting for the digital signal from the HDMI or DIGITAL OUT terminal.
  • "digitalMusicEnhancer" - Set Digital Music Enhancer function for output when playing Internet content or USB content.
  • "downMix" - The downmix setting, whether to enable surround effects or not when downmixing to PCM 2ch from a multi channel source, such as, BD LPCM, DTS HD, Dolby TrueHD, DD+, DD, DTS, or AAC.
  • "dsdMode" - The sound setting for HDMI when playing SACD audio from a DSD file.
  • "dseeHX" - Set whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "dseeHXTmp" - Set temporary whether using the DSEE HX function. DSEE HX is advanced DSEE (Digital Sound Enhancement Engine) function and upscales existing sound sources to near hi-resolution sound quality.
  • "dtsNeo6" - Settings for DTS Neo:6.
  • "dualMono" - Set Dual Mono mode.
  • "footballMode" - Football Mode
  • "inputAttenuation" - Reduces the input sensitivity of audio signal input to Audio analog audio input terminal.
  • "nightMode" - Set Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "nightModeTmp" - Set temporary Night mode. Sound is output at low volume with minimum loss of fidelity and clarity of dialogue.
  • "optimizer" - Set Sound Optimizer function. Enjoying clear and dynamic sound at a low volume.
  • "outputTerminal" - Selecting speakers or terminals to output sound.
  • "pureDirect" - Set Pure Direct function. When the Pure Direct function is on, the display panel lights off to suppress noise that affects sound quality.
  • "sceneSelection" - Set Custom Preset scene. Each preset scene saves various settings with the player, monitor, etc., according to listening and viewing style.
  • "soundField" - The sound quality according to the music genre.
  • "soundFiedlMovie" - Set Sound Field Movie function.
  • "voice" - Set Voice mode. This helps make dialogues clearer.
  • "wideStereo" - Set Wide Stereo mode for immersive stereo sound.

settings.value
type

string

multiplicity

1

The value to apply to the sound setting.

  • In case "target" is "aac"
    • "downmixPcm" - Converted (downmixed) LPCM output
    • "aac" - AAC output
  • In case "target" is "audioDRC"
    • "auto" - The system uses DRC as set on the disc, only for BD-ROM.
    • "on" - The system uses DRC as set by the recording engineer.
    • "off" - The system disables DRC.
    • "standard" - The system uses DRC between "tv" and "wideRange".
    • "tv" - The system uses DRC that emphasizes faint sounds, for TV speakers.
    • "wideRange" - The system uses DRC optimized for Hi-Fi speakers.
  • In case "target" is "audioPurenessControl"
    • "on" - Enable APC function
    • "off" - Disable APC function
  • In case "target" is "audioPurenessControlTmp"
    • "on" - Enable APC function
    • "off" - Disable APC function
  • In case "target" is "autoFormatDirect_2ch"
    • "2chStereo" - 2ch Stereo. The receiver outputs the sound from the front left/right speakers only. There is no sound from the subwoofer.
    • "analogDirect" - Analog Direct. You can switch the audio of the selected input to 2-channel analog input. This function enables you to enjoy high-quality analog sources.
    • "auto" - Auto Format Direct (A.F.D.) Presets the sound as it was recorded/encoded without adding any surround effects.
    • "multiStereo" - Multi stereo. Outputs 2-channel left/right or monaural signals from all speakers.
    • "surround" - This mode expands a 2 channel audio source to multi channel.
    • "off" - Disable A.F.D/2ch function
  • In case "target" is "autoGenreSelector"
    • "on" - Enable Auto Genre Selector function.
    • "off" - The Auto Genre selector function is disable.
  • In case "target" is "avSyncMs"
    • 0 - Min value.
    • : (step by 25)
    • 300 - Max value.
  • In case "target" is "bdMixMode"
    • "on" - Outputs the audio obtained by mixing the interactive and secondary audio to the primary audio.
    • "off" - Outputs the primary audio only, outputs HD audio signals, such as Dolby TrueHD, to an AV Receiver.
  • In case "target" is "calibrationType"
    • "fullFlat" - Full Flat. Makes the measurement of frequency from each speaker flat.
    • "engineer" - Engineer. Sets to "the Sony listening room standard" frequency characteristics.
    • "frontReference" - Front Reference. Adjusts the characteristics of all of the speakers to match the characteristics of the front speaker.
    • "off" - Disable Calibration type.
  • In case "target" is "clearAudio"
    • "on" - Enable Clear Audio + function
    • "off" - Disable Clear Audio + function
  • In case "target" is "convertToDolbyD"
    • "on" - Convert DTS source to Dolby Digital by referring EDID.
    • "off" - Not convert DTS source to Dolby Digital
  • In case "target" is "digitalAudioType"
    • "auto" - PCM and BitStream can switch automatically according to connection device.
    • "pcm" - PCM output from HDMI or digital audio output.
    • "multiPcm" - Multi channel PCM output from HDMI or digital audio output.
    • "2chPcm" - 2 channel PCM output from HDMI or digital audio output.
  • In case "target" is "digitalMusicEnhancer"
    • "on" - Three elements (PAE+(Portable Audio Enhancer Plus), Dynamic Range Recovery, Advanced Auto Volume) are enabled to create better sound quality for Internet content or USB content.
    • "off" - Turns off the Digital Music Enhancer function.
    • "soundBarMode" - Same as setting value "off", the purpose of this setting value is to force sound bar users to use off.
  • In case "target" is "downMix"
    • "surround" - Enables surround effects in audio output.
    • "stereo" - Disables surround effects in audio output.
  • In case "target" is "dsdMode"
    • "auto" - DSD output
    • "off" - PCM output
  • In case "target" is "dseeHX"
    • "auto" - Enable DSEE HX function only when sound is 2ch.
    • "on" - Enable DSEE HX function always regardless of the number of channel.
    • "off" - Disable DSEE HX function
  • In case "target" is "dseeHXTmp"
    • "auto" - Enable DSEE HX function only when sound is 2ch.
    • "on" - Enable DSEE HX function always regardless of the number of channel.
    • "off" - Disable DSEE HX function
  • In case "target" is "dtsNeo6"
    • "cinema" - Neo:6 Cinema settings for movie.
    • "music" - Neo:6 Music settings for audio.
    • "off" - Disable Neo:6 function.
  • In case "target" is "dualMono"
    • "main_sub" - Main/Sub mode. Sound in the main language will be output through the front left speaker and sound in the sub language will be output through the front right speaker simultaneously.
    • "main" - Main mode. Sound in the main language will be output.
    • "sub" - Sub mode. Sound in the sub language will be output.
  • In case "target" is "footballMode"
    • "on" - Enable Football Mode with narration
    • "on_narration_off" - Enable Football Mode without narration
    • "off" - Disable Football Mode
  • In case "target" is "inputAttenuation"
    • "on" - Enable input attenuation function
    • "off" - Disable input attenuation function
  • In case "target" is "nightMode"
    • "on" - Enable Night mode.
    • "off" - Disable Night mode.
  • In case "target" is "nightModeTmp"
    • "on" - Enable Night mode.
    • "off" - Disable Night mode.
  • In case "target" is "optimizer"
    • "normal" - Normal mode. Adjusts for the reference level of a movie.
    • "low" - Low mode. Adjusts for a CD or other software whose average sound pressure level is processed highly.
    • "off" - Disable Sound Optimizer function.
  • In case "target" is "outputTerminal"
    • "speaker" - Audio is output from speaker.
    • "speaker_hdmi" - Audio is output from speaker and HDMI.
    • "hdmi" - Audio is output from HDMI.
    • "audioSystem" - Audio is output from HDMI or digital audio output.
  • In case "target" is "pureDirect"
    • "on" - Enable Pure Direct function.
    • "off" - Disable Pure Direct function.
  • In case "target" is "sceneSelection"
    • "movie" - Movie scene.
    • "music" - Music scene.
    • "party" - Party scene.
    • "night" - Night scene.
    • "undo" - Undo custom preset scene settings.
    • "" - Scene Selection Settings is Unknown.
  • In case "target" is "soundField"
    • "standard" - Music Equalizer Standard. Sound effects are optimized for the individual source.
    • "rock" - Music Equalizer Rock
    • "hiphop" - Music Equalizer Hip Hop
    • "electronica" - Music Equalizer Electronica
    • "sertanejo" - Music Equalizer Sertanejo
    • "movie" - Movie mode. Sound effects are optimized for movies. This mode replicates the density and rich expanse of sound.
    • "movie2" - Movie2 mode. Sound effects are optimized for movies. This mode replicates sound looping around the listener to the rear.
    • "music" - Music mode. Sound effects are optimized for music.
    • "game" - Game mode. Sound effects are optimized for game play.
    • "compressionMusic" - Digital Music mode
    • "night" - Night mode
    • "flat" - Flat mode
    • "pop" - Pop mode
    • "jazz" - Jazz mode. Reproduces the acoustics of a jazz club.
    • "latin" - Latin mode
    • "classic" - Classic mode
    • "custom" - Custom mode
    • "clearAudio" - Clear Audio + mode. The appropriate sound setting is automatically selected for the sound source.
    • "sports" - Sports mode. Reproduces the feel of sports broadcasting.
    • "live" - Live mode. Reproduces the acoustics of a 300-seat live house.
    • "stadium" - Stadium mode. Reproduces the feel of a large open-air stadium
    • "proLogicIIMusic" - Pro Logic II Music mode. Performs Dolby Pro Logic II Music mode decoding. This setting is ideal for normal stereo sources such as CDs.
    • "proLogicIIxMusic" - Pro Logic IIx Music mode. Performs Dolby Pro Logic IIx Music mode decoding. This setting is ideal for normal stereo sources such as CDs.
    • "neo6Music" - Neo6 Music mode. Performs DTS Neo:6 Music mode decoding. Sources recorded in 2-channel format are enhanced up to 7 channels. This setting is ideal for normal stereo sources such as CDs.
    • "concertHallA" - Concert Hall A. Reproduces the acoustics of a vineyard style concert hall in Berlin famous for its clear acoustics.
    • "concertHallB" - Concert Hall B. Reproduces the acoustics of a shoe box style concert hall with plaster walls in Amsterdam.
    • "concertHallC" - Concert Hall C. Reproduces the acoustics of a wooden shoe box style concert hall in Vienna.
    • "portableAudio" - Portable Audio. Reproduces clear enhanced sound from your portable audio device. This mode is ideal for MP3s and other compressed music.
    • "cinemaStudio" - Cinema Studio. Sound effect are optimized for higher realistic sound like a cinema studio.
    • "musicArena" - Music Arena. Sound effects like a live music concerts filled with great excitement created by Sony’s unique Audio DSP technology.
    • "headPhone2ch" - This mode is selected automatically when connecting headphones. Standard 2-channel stereo sources completely bypass the sound field processing and multi-channel surround formats are downmixed to 2 channels except LFE signals.
    • "off" - Disable Sound Field function.
  • In case "target" is "soundFiedlMovie"
    • "hdDcsDynamic" - HD Digital Cinema Sound (HD-D.C.S.) Dynamic. This setting is suitable for an environment which is reverberant but lacks a spacious feel (where sound absorption is not sufficient). It emphasizes the reflection of sound and reproduces the sound of a large, classic movie theater.
    • "hdDcsTheater" - HD Digital Cinema Sound (HD-D.C.S.) Theater. This setting is suitable for a general living room. It reproduces the reverberation of sound just like in a movie theater (dubbing theater). It is most appropriate for watching content recorded on a Blu-ray Disc when you want the atmosphere of a movie theater
    • "hdDcsStudio" - HD Digital Cinema Sound (HD-D.C.S.) Studio. This setting is suitable for a living room with the appropriate sound devices. It reproduces the reverberation of sound provided when a theatrical sound source is remixed for a Blu-ray Disc to a volume level suitable for home use.
    • "proLogicII" - Dolby Pro Logic II Movie mode decoding. This setting is ideal for movies encoded in Dolby Surround.
    • "proLogicIIx" - Dolby Pro Logic IIx Movie mode decoding. This setting expands Dolby Pro Logic II Movie or Dolby Digital 5.1 to 7.1 discrete movie channels.
    • "neo6Cinema" - DTS Neo:6 Cinema mode decoding. Sources recorded in 2-channel format are enhanced up to 7 channels.
    • "frontSurrond" - An immersive virtual surround sound experience with only front speakers.
    • "off" - Disable Sound Field Movie function.
  • In case "target" is "voice"
    • "type1" - Type 1. Standard.
    • "type2" - Type 2. Dialogue range is enhanced.
    • "type3" - Type 3. Dialogue range is enhanced, and the parts of range difficult to be discerned by the elderly are boosted.
  • In case "target" is "wideStereo"
    • "high" - Wide Stereo High mode.
    • "standard" - Wide Stereo Standard mode.

Examples

{
 "method":"setSoundSettings",
 "id":5,
 "params":[
  {
   "settings":[
    {
     "value":"on",
     "target":"digitalAudioType"
    }
   ]
  }
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

Following error codes are important for this API. Refer to error code for other errors.

40004

The service failed to update one or more settings. Call the associated get settings method to identify which settings still need to be updated.

Examples

{
 "result":[],
 "id":5
}

stopPlayingContent (v1.1)

Lib

avContent

Supported by

STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Stops the currently playing content. The keepLastFrame parameter is valid for video content with this parameter true by v1_2.setPlayContent API when it reaches to end or when it is stopped by this API with this parameter true.

setPlayContent (v1.2)

Sets the playing content or changes the active input.

pausePlayingContent (v1.1)

Toggles between the play and pause states for the current content.

getPlayingContentInfo (v1.2)

Gets information about the playing content or current selected input.

Request

Format description

{
 "id":"integer",
 "method":"stopPlayingContent",
 "params":[
  {
   "keepLastFrame":"boolean",
   "output":"string"
  }
 ],
 "version":"v1.1"
}

params Elements

keepLastFrame
type

boolean

multiplicity

?

default

false

Applies only to video content. Indicates whether to keep the last frame when playback stops.

output
type

string

multiplicity

?

default

""

The URI of the output terminal to affect. To get information about the current status of all external output terminal sources of the device, see the v1_0.getCurrentExternalTerminalsStatus method. For more information about the URI structure, see the Device Resource URI page.

  • (ex) "extOutput:zone?zone=2"

Examples

{
 "method":"stopPlayingContent",
 "id":28,
 "params":[
  {}
 ],
 "version":"1.1"
}

Response

Format description

Schema
{"id":"integer","result":[]}

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[],
 "id":28
}

switchNotifications (v1.0)

Lib

Common APIs

Supported by

SRS-ZR5 STR-DN1080 HT-MT500 HT-CT800 HT-ST5000 HT-ZF9

Description

Subscribes and unsubscribes to multiple notifications at a time.

getSupportedApiInfo (v1.0)

This API provides supported services and its information.

Request

Format description

{
 "id":"integer",
 "method":"switchNotifications",
 "params":[
  {
   "disabled":[
    {
     "name":"string",
     "version":"string"
    }
   ],
   "enabled":[
    {
     "name":"string",
     "version":"string"
    }
   ]
  }
 ],
 "version":"v1.0"
}

params Elements

disabled
type

(object-array)

multiplicity

?

default

null

The notifications from which to unsubscribe.

disabled.name
type

string

multiplicity

1

The notification name.

disabled.version
type

string

multiplicity

1

The notification version.

enabled
type

(object-array)

multiplicity

?

default

null

The notifications to which to subscribe.

enabled.name
type

string

multiplicity

1

The notification name.

enabled.version
type

string

multiplicity

1

The notification version.

Examples

{
 "method":"switchNotifications",
 "id":6,
 "params":[
  {
   "disabled":[
    {
     "name":"notify2",
     "version":"1.0"
    }
   ],
   "enabled":[
    {
     "name":"notify1",
     "version":"1.0"
    },
    {
     "name":"notApplicableNotify",
     "version":"1.0"
    },
    {
     "name":"priveteNotify",
     "version":"1.0"
    }
   ]
  }
 ],
 "version":"1.0"
}

Response

Format description

{
 "id":"integer",
 "result":[
  {
   "disabled":[
    {
     "name":"string",
     "version":"string"
    }
   ],
   "enabled":[
    {
     "name":"string",
     "version":"string"
    }
   ],
   "rejected":[
    {
     "name":"string",
     "version":"string"
    }
   ],
   "unsupported":[
    {
     "name":"string",
     "version":"string"
    }
   ]
  }
 ]
}

result Elements

disabled
multiplicity

1

type

(object-array)

The notifications from which you successfully unsubscribed.

disabled.name
multiplicity

1

type

string

The notification name.

disabled.version
multiplicity

1

type

string

The notification version.

enabled
multiplicity

1

type

(object-array)

The notifications to which you successfully subscribed.

enabled.name
multiplicity

1

type

string

The notification name.

enabled.version
multiplicity

1

type

string

The notification version.

rejected
default

null

multiplicity

?

type

(object-array)

The notifications rejected because you lacked authentication to subscribe or unsubscribe to.

rejected.name
multiplicity

1

type

string

The notification name.

rejected.version
multiplicity

1

type

string

The notification version.

unsupported
default

null

multiplicity

?

type

(object-array)

The notifications rejected because they are not recognized by the service.

unsupported.name
multiplicity

1

type

string

The notification name.

unsupported.version
multiplicity

1

type

string

The notification version.

Error codes

No additional error code is defined. Refer to error code for common errors.

Examples

{
 "result":[
  {
   "unsupported":[
    {
     "name":"notApplicableNotify",
     "version":"1.0"
    }
   ],
   "rejected":[
    {
     "name":"priveteNotify",
     "version":"1.0"
    }
   ],
   "disabled":[
    {
     "name":"priveteNotify",
     "version":"1.0"
    },
    {
     "name":"notify2",
     "version":"1.0"
    }
   ],
   "enabled":[
    {
     "name":"notify1",
     "version":"1.0"
    }
   ]
  }
 ],
 "id":6
}