From OpenHome

(Difference between revisions)
Jump to: navigation, search
(Kazoo Server)
(Tidal & Qobuz)
Line 11: Line 11:
The current pin version is <tt>1</tt>. The version has been omitted from the examples below.
The current pin version is <tt>1</tt>. The version has been omitted from the examples below.
-
= Supported Pins =
+
= (Linn) Kazoo Server =
-
 
+
-
== (Linn) Kazoo Server ==
+
{|
{|
Line 73: Line 71:
   // List pin
   // List pin
   openhome.me://[type]?udn=[device udn]&me=[endpoint id]&list=[item id]&response[response type]
   openhome.me://[type]?udn=[device udn]&me=[endpoint id]&list=[item id]&response[response type]
 +
</code>
 +
 +
= Tidal =
 +
== Tracks ==
 +
 +
{|
 +
|-
 +
| mode
 +
| tidal
 +
|-
 +
| type
 +
| track
 +
|-
 +
| ''Query Parameters''
 +
|
 +
|-
 +
| trackId
 +
| Tidal track id
 +
|}
 +
 +
Example Uri:
 +
<code>
 +
  tidal://track?trackId=[id]
 +
</code>
 +
 +
== Other Tidal Content ==
 +
 +
For other Tidal content the pin will provide a link to the Tidal API resource and a hint as to what you expect that resource to return.
 +
 +
{|
 +
|-
 +
| mode
 +
| tidal
 +
|
 +
|-
 +
| type
 +
| album
 +
| Requires response type tracks
 +
|-
 +
|
 +
| artist
 +
| Requires response type albums
 +
|-
 +
|
 +
| playlist
 +
| Requires response type tracks
 +
|-
 +
|
 +
| genre
 +
| Requires response type of either albums, playlists or tracks
 +
|-
 +
|
 +
| container
 +
| Requires response type of either albums, playlists or tracks
 +
|-
 +
| ''Query Parameters''
 +
|
 +
|
 +
|-
 +
| path
 +
| Tidal API link
 +
| Must to be url encoded
 +
|-
 +
| response
 +
| Response type
 +
| See above
 +
|}
 +
 +
Example Uri:
 +
<code>
 +
  tidal://[type]?path=[api link]&response=[response type]
 +
</code>
 +
 +
 +
= Qobuz =
 +
== Tracks ==
 +
 +
{|
 +
|-
 +
| mode
 +
| qobuz
 +
| type
 +
| track
 +
|-
 +
| ''Query Parameters''
 +
|
 +
|-
 +
| trackId
 +
| Qobuz track id
 +
|}
 +
 +
Example Uri:
 +
<code>
 +
  qobuz://track?trackId=[id]
 +
</code>
 +
 +
== Other Qobuz Content ==
 +
 +
For other Qobuz content the pin will provide a link to the Qobuz API resource and a hint as to what you expect that resource to return.
 +
 +
{|
 +
|-
 +
| mode
 +
| qobuz
 +
|
 +
|-
 +
| type
 +
| album
 +
| Requires response type tracks
 +
|-
 +
|
 +
| artist
 +
| Requires response type albums
 +
|-
 +
|
 +
| playlist
 +
| Requires response type tracks
 +
|-
 +
|
 +
| container
 +
| Requires response type of either albums, playlists
 +
|-
 +
| ''Query Parameters''
 +
|
 +
|
 +
|-
 +
| path
 +
| Qobuz API link
 +
| Must to be url encoded
 +
|-
 +
| response
 +
| Response type
 +
| See above
 +
|-
 +
|}
 +
 +
Example Uri:
 +
<code>
 +
  qobuz://[type]?path=[api link]&response=[response type]
</code>
</code>

Revision as of 16:47, 20 August 2018

Contents

Overview

All pins have a uri associated with them which is used by the pins service to interpret one or more playable items and must be in the following form:

<mode>://<type>?<pin specific query parameters>&version<pin version>

The mode indicates which music provider will provide the playable content. Each has a number of query parameters which are outlined below. The pins service allows you to query which modes the device currently supports.

The type describes what the pin is such as an artist, album or playlist.

The current pin version is 1. The version has been omitted from the examples below.

(Linn) Kazoo Server

mode openhome.me
type album Requires response type tracks
artist Requires response type albums
playlist Requires response type tracks
genre Requires response type of either albums, playlists or tracks
container Only supported in a list pin
Query Parameters
udn Server's Udn
me Endpoint Id
response Response type See above
browse Item id Performs a browse query with the given item id. Can't contain list parameter
list Tag id Performs a list query with given tag id. Can't contain a browse parameter

Example Uris: 

 // Browse pin
 openhome.me://[type]?udn=[device udn]&me=[endpoint id]&browse=[item id]&response=[response type]
 
 // List pin
 openhome.me://[type]?udn=[device udn]&me=[endpoint id]&list=[item id]&response[response type]

Tidal

Tracks

mode tidal
type track
Query Parameters
trackId Tidal track id

Example Uri: 

 tidal://track?trackId=[id]

Other Tidal Content

For other Tidal content the pin will provide a link to the Tidal API resource and a hint as to what you expect that resource to return.

mode tidal
type album Requires response type tracks
artist Requires response type albums
playlist Requires response type tracks
genre Requires response type of either albums, playlists or tracks
container Requires response type of either albums, playlists or tracks
Query Parameters
path Tidal API link Must to be url encoded
response Response type See above

Example Uri: 

 tidal://[type]?path=[api link]&response=[response type]


Qobuz

Tracks

mode qobuz type track
Query Parameters
trackId Qobuz track id

Example Uri: 

 qobuz://track?trackId=[id]

Other Qobuz Content

For other Qobuz content the pin will provide a link to the Qobuz API resource and a hint as to what you expect that resource to return.

mode qobuz
type album Requires response type tracks
artist Requires response type albums
playlist Requires response type tracks
container Requires response type of either albums, playlists
Query Parameters
path Qobuz API link Must to be url encoded
response Response type See above

Example Uri: 

 qobuz://[type]?path=[api link]&response=[response type]

Retrieved from "http://wiki.openhome.org/wiki/Av:Developer:PinInvokers"