summaryrefslogtreecommitdiff
path: root/rest-api
diff options
context:
space:
mode:
Diffstat (limited to 'rest-api')
-rw-r--r--rest-api/api-docs/bridges.json12
-rw-r--r--rest-api/api-docs/channels.json12
-rw-r--r--rest-api/api-docs/events.json12
-rw-r--r--rest-api/api-docs/playbacks.json10
4 files changed, 32 insertions, 14 deletions
diff --git a/rest-api/api-docs/bridges.json b/rest-api/api-docs/bridges.json
index b608be6d6..ab2c6c2d5 100644
--- a/rest-api/api-docs/bridges.json
+++ b/rest-api/api-docs/bridges.json
@@ -328,10 +328,10 @@
},
{
"name": "media",
- "description": "Media's URI to play.",
+ "description": "Media URIs to play.",
"paramType": "query",
"required": true,
- "allowMultiple": false,
+ "allowMultiple": true,
"dataType": "string"
},
{
@@ -344,7 +344,7 @@
},
{
"name": "offsetms",
- "description": "Number of media to skip before playing.",
+ "description": "Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -420,10 +420,10 @@
},
{
"name": "media",
- "description": "Media's URI to play.",
+ "description": "Media URIs to play.",
"paramType": "query",
"required": true,
- "allowMultiple": false,
+ "allowMultiple": true,
"dataType": "string"
},
{
@@ -436,7 +436,7 @@
},
{
"name": "offsetms",
- "description": "Number of media to skip before playing.",
+ "description": "Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.",
"paramType": "query",
"required": false,
"allowMultiple": false,
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index 2389f7cb9..aafd231a1 100644
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -973,10 +973,10 @@
},
{
"name": "media",
- "description": "Media's URI to play.",
+ "description": "Media URIs to play.",
"paramType": "query",
"required": true,
- "allowMultiple": false,
+ "allowMultiple": true,
"dataType": "string"
},
{
@@ -989,7 +989,7 @@
},
{
"name": "offsetms",
- "description": "Number of media to skip before playing.",
+ "description": "Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.",
"paramType": "query",
"required": false,
"allowMultiple": false,
@@ -1055,10 +1055,10 @@
},
{
"name": "media",
- "description": "Media's URI to play.",
+ "description": "Media URIs to play.",
"paramType": "query",
"required": true,
- "allowMultiple": false,
+ "allowMultiple": true,
"dataType": "string"
},
{
@@ -1071,7 +1071,7 @@
},
{
"name": "offsetms",
- "description": "Number of media to skip before playing.",
+ "description": "Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified.",
"paramType": "query",
"required": false,
"allowMultiple": false,
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json
index dee7c2db9..ca2616101 100644
--- a/rest-api/api-docs/events.json
+++ b/rest-api/api-docs/events.json
@@ -146,6 +146,7 @@
"subTypes": [
"DeviceStateChanged",
"PlaybackStarted",
+ "PlaybackContinuing",
"PlaybackFinished",
"RecordingStarted",
"RecordingFinished",
@@ -270,6 +271,17 @@
}
}
},
+ "PlaybackContinuing": {
+ "id": "PlaybackContinuing",
+ "description": "Event showing the continuation of a media playback operation from one media URI to the next in the list.",
+ "properties": {
+ "playback": {
+ "type": "Playback",
+ "description": "Playback control object",
+ "required": true
+ }
+ }
+ },
"PlaybackFinished": {
"id": "PlaybackFinished",
"description": "Event showing the completion of a media playback operation.",
diff --git a/rest-api/api-docs/playbacks.json b/rest-api/api-docs/playbacks.json
index 63df3f24b..9f9003558 100644
--- a/rest-api/api-docs/playbacks.json
+++ b/rest-api/api-docs/playbacks.json
@@ -124,9 +124,14 @@
},
"media_uri": {
"type": "string",
- "description": "URI for the media to play back.",
+ "description": "The URI for the media currently being played back.",
"required": true
},
+ "next_media_uri": {
+ "type": "string",
+ "description": "If a list of URIs is being played, the next media URI to be played back.",
+ "required": false
+ },
"target_uri": {
"type": "string",
"description": "URI for the channel or bridge to play the media on",
@@ -145,7 +150,8 @@
"values": [
"queued",
"playing",
- "complete"
+ "continuing",
+ "done"
]
}
}