Simonc: Created page with "= Changes between Davaar and Eriskay = This page outlines the API changes between Davaar and Eriskay. == Device == New service. Control points use this service to determine wh..."

2015-12-15T14:54:55Z

Created page with "= Changes between Davaar and Eriskay = This page outlines the API changes between Davaar and Eriskay. == Device == New service. Control points use this service to determine wh..."

New page

= Changes between Davaar and Eriskay =

This page outlines the API changes between Davaar and Eriskay.

== Device ==
New service.

Control points use this service to determine whether a device is using compatible software. The presence of some services below can be inferred from this service.

== Product ==
Still the entrypoint for Topology algorithm. Control points no longer need to search for this – its presence can be inferred by checking for the <tt>openhome.org.product</tt> attribute in the versions section of the [[Av:Developer:Eriskay:DeviceService | Device]] description.

The following actions / properties have changed:
* <tt>SourceXml</tt> is now <tt>SourceArray</tt> and is formatted as JSON
* Similarly, <tt>SourceXmlChangeCount</tt> is now <tt>SourceArrayChangeCount</tt>
* <tt>ProductName</tt> and <tt>ProductRoom</tt> are now simply <tt>Name</tt> and <tt>Room</tt>
* The <tt>Product</tt> action is now <tt>Names</tt>
* <tt>SetSourceIndexByName</tt> and <tt>SetSourceIndex</tt> have been replaced by <tt>SetSource</tt>
* <tt>SourceIndex</tt> has been replaced by <tt>SourceSystemName</tt>

The following actions / properties have been (re)moved:
* <tt>SourceCount</tt> and <tt>SourceIndex</tt> have been removed. Use the <tt>SetSource</tt> action and <tt>SourceSystemName</tt> property instead.
* The <tt>Source</tt> action has been removed. Use <tt>SourceArray</tt>, parsing the JSON returned, to get information about a single source.
* <tt>Standby</tt> has been removed and is now available via the [[Av:Developer:Eriskay:DeviceService | Device]] service.
* The various <tt>Manufacturer</tt> properties and <tt>Manufacturer</tt> action have been removed and are now available via the [[Av:Developer:Eriskay:DeviceService | Device]] service.
* The various <tt>Model</tt> properties and <tt>Model</tt> action have been removed and are now available via the [[Av:Developer:Eriskay:DeviceService | Device]] service.
* The <tt>ProductInfo</tt>, <tt>ProductUri</tt>, <tt>ProductImageUri</tt> properties have been removed and are no longer returned by the <tt>Product</tt> action. These can now be read via the [[Av:Developer:Eriskay:DeviceService | Device]] service.
* <tt>SetSourceIndexByName</tt> has been removed.

The following actions / properties have been added:
* <tt>Home</tt> provides an identifier for a group of rooms. Traditional control points do not need to use this.

== Info ==
Removed. Use the [[Av:Developer:Eriskay:TransportService | Transport]] service instead.

== Transport ==
New service.

Replaces Info service plus transport commands (<tt>Play</tt>, <tt>Pause</tt>, <tt>Stop</tt>, <tt>Next</tt>, <tt>Prev</tt>, <tt>SeekSecondsAbsolute</tt> and <tt>SeekSecondsRelative</tt>) from source-specific services.

== Time ==
No Changes

== Volume ==
Removed the <tt>VolumeMilliDbPerStep</tt> property. Control points which set volume as an absolute decibel level are no longer supported.

One new property – <tt>UnityGain</tt> – which reports whether the current channel is already volume controlled.

== Credentials ==
<tt>ReLogin</tt> action renamed <tt>Relogin</tt>.

Tokens and data returned for Tidal and Qobuz streaming services are now JSON arrays to allow for additional information to be communicated in future.

== Sender==
<tt>Attributes</tt> and <tt>PresentationUrl</tt> properties / getters have been removed. These can be published as attributes via the [[Av:Developer:Eriskay:DeviceService | Device]] service if required.

<tt>Metadata</tt> format has changed from DIDL-Lite to OpenHome Metadata.

Updated list of allowed values for <tt>Status</tt> property (no change in behaviour – Davaar docs were incorrect).

== Configuration ==
New service.

Developer aid that may be useful from test programs but should not be used in production code.

== Playlist ==
The following actions have been removed. Use equivalents in [[Av:Developer:Eriskay:TransportService | Transport]] service instead:
* <tt>Play</tt> / <tt>Pause</tt> / <tt>Stop</tt>
* <tt>Next</tt> / <tt>Prev</tt>
* <tt>SeekSecondsAbsolute</tt> / <tt>SeekSecondsRelative</tt>
* <tt>TransportState</tt>

<tt>Read</tt> and <tt>DeleteId</tt> have been removed. Use <tt>ReadList</tt> and <tt>DeleteList</tt> instead.

<tt>Metadata</tt> passed to <tt>Insert</tt> is expected to now be in OpenHome Metadata format. Whatever format is passed in will be returned from both <tt>Read</tt> and <tt>ReadList</tt>.

The following actions have been added:
* <tt>Move</tt>, which simplifies playlist editing
* <tt>DeleteList</tt>, which simplifies bulk deletion (e.g. an entire album).

The <tt>IdArray</tt> property now has string type and contains a JSON integer array.

The <tt>SeekId</tt> and <tt>SeekIndex</tt> actions have been removed. Equivalent functionality is available via
 <tt>Transport.PlayAs("playlist", "id=[track_id]")</tt> 
or
 <tt>Transport.PlayAs("playlist", "index=[track_index]")</tt>

The <tt>ProtocolInfo</tt> property / getter has been removed. Control points are recommended to just queue any audio content with a player. Any that still want to check audio capabilities can do so via <tt>AVTransport</tt>.

== Radio ==
The following actions have been removed. Use equivalents in [[Av:Developer:Eriskay:TransportService | Transport]] service instead:
U <tt>Play</tt> / <tt>Pause</tt> / <tt>Stop</tt>
U <tt>SeekSecondsAbsolute</tt> / <tt>SeekSecondsRelative</tt>
U <tt>TransportState</tt>

<tt>Next</tt> / <tt>Prev</tt> are now supported via the [[Av:Developer:Eriskay:TransportService | Transport]] service

<tt>Metadata</tt> (for the current track and from <tt>Read</tt> / <tt>ReadList</tt>) is now in OpenHome Metadata format

The <tt>IdArray</tt> property now has string type and contains a JSON integer array.

The <tt>SetId</tt> and <tt>SetChannel</tt> actions have been removed. Equivalent functionality is available via
 <tt>Transport.PlayAs("radio", "id=[preset_id]")</tt> 
or
 <tt>Transport.PlayAs("single", "{"url": "[track_url]", "metadata": "{track_metadata]"}")</tt>

The <tt>ProtocolInfo</tt> property / getter has been removed. Control points are recommended to just queue any audio content with a player. Any that still want to check audio capabilities can do so via <tt>AVTransport</tt>.

== Receiver ==
The <tt>TransportState</tt> property and getter have been removed. Use equivalents in [[Av:Developer:Eriskay:TransportService | Transport]] service instead.

The <tt>ProtocolInfo</tt> property / getter is now a space-separated list of protocols.

The <tt>SetSender</tt> action has been removed. Equivalent functionality is available via
 <tt>Transport.PlayAs("receiver", "{"url": "[sender_url]", "metadata": "[openhome_sender_metadata]"}")</tt>

== Exakt ==
Service has been moved to the <tt>linn.co.uk</tt> domain.

There are no guarantees about compatibility so use by third parties is not encouraged.

== NetworkMonitor ==
Service has been moved to the <tt>linn.co.uk</tt> domain.

There are no guarantees about compatibility so use by third parties is not encouraged.

== PlaylistManager ==
Service has been withdrawn.

There is no support for shared playlists in Eriskay media servers.

Equivalent functionality may be supported by a cloud service in future.

Av:Developer:Eriskay:DavaarChanges - Revision history

Simonc: Created page with "= Changes between Davaar and Eriskay = This page outlines the API changes between Davaar and Eriskay. == Device == New service. Control points use this service to determine wh..."