QRemote REST API Documentation

July 14, 2012 19:20 by docbliny 

The QRemote REST API documentation is now bundled into the application itself, but here’s a copy/paste for reference.

Media Playback Settings and Control

You can retrieve information about and control media playback by manipulating objects under the /media/controls, /media/settings/, and /media/playlist/current/items/current resources.

controls Resource

The controls resource contains information about the current playback state.

URI

/api/V1/media/controls

Supported Methods

  • GET: Gets the current playback status.
  • PUT: Sets the current playback status.

Resource Representations

{
    "status": "stop"
}
Property Name Data Type Description
status string Identifies the playback state. Valid values are: unknown, stop, play, and pause.

settings/repeat Resource

The settings/repeat resource contains information about the current repeat mode.

URI

/api/V1/media/settings/repeat

Supported Methods

  • GET: Gets the current repeat mode.

Resource Representations

{
    "value": "single"
}
Property Name Data Type Description
value string Identifies the repeat mode. Valid values are: unknown, off, single, and all.

settings/shuffle Resource

The settings/shuffle resource contains information about the current shuffle mode.

URI

/api/V1/media/settings/shuffle

Supported Methods

  • GET: Gets the current shuffle mode.

Resource Representations

{
    "value": "all"
}
Property Name Data Type Description
value string Identifies the shuffle mode. Valid values are: unknown, off, and all.

settings/mute Resource

The settings/mute resource contains information about the current mute mode.

URI

/api/V1/media/settings/mute

Supported Methods

  • GET: Gets the current mute mode.
  • PUT: Sets the current mute mode.

Resource Representations

{
    "value": "on"
}
Property Name Data Type Description
value string Identifies the mute mode. Valid values are: unknown, off, and on.

settings/volume Resource

The settings/volume resource contains information about the current volume level.

URI

/api/V1/media/settings/volume

Supported Methods

  • GET: Gets the current volume level.
  • PUT: Sets the current volume level.

Resource Representations

{
    "value": 75
}
Property Name Data Type Description
value integer The volume level. Valid values are: unknown (read only), an integer between 0 and 100.

playlist Resources

The playlist sub-resources contain information about the currently playing item.

URI

/api/V1/media/playlist/current/items/current

Supported Methods

  • GET: Gets information about the currently playing item.
  • POST: Sets the currently playing item. Currently only the pseudo-URIs urn:media:item:previous and urn:media:item:next are supported

Resource Representations

{
    "artistName": "Will Atkinson presents Darkboy",
    "uri": "urn:google:play:164364289",
    "titleName": "Darker Shades Of Black (Blazer Radio Edit)",
    "albumName": "DJ Box - July 2012"
}

To navigate to the next item in the playlist, POST the following object:

{
    "uri": "urn:media:item:next"
}
Property Name Data Type Description
albumName string The name of the album.
artistName string The name of the artist.
titleName string The title of the currently playing item.
uri string The URI of the currently playing item.

Add comment

  Country flag

biuquote
  • Comment
  • Preview
Loading