diff options
Diffstat (limited to 'rest-api/api-docs/playback.json')
| -rw-r--r-- | rest-api/api-docs/playback.json | 32 |
1 files changed, 30 insertions, 2 deletions
diff --git a/rest-api/api-docs/playback.json b/rest-api/api-docs/playback.json index 38ca5e1a7..884c0db26 100644 --- a/rest-api/api-docs/playback.json +++ b/rest-api/api-docs/playback.json @@ -103,11 +103,39 @@ "models": { "Playback": { "id": "Playback", + "description": "Object representing the playback of media to a channel", "properties": { "id": { + "type": "string", + "description": "ID for this playback operation", + "required": true + }, + "media_uri": { + "type": "string", + "description": "URI for the media to play back.", + "required": true + }, + "target_uri": { + "type": "string", + "description": "URI for the channel or bridge to play the media on", + "required": true + }, + "language": { + "type": "string", + "description": "For media types that support multiple languages, the language requested for playback." + }, + "state": { + "type": "string", + "description": "Current state of the playback operation.", "required": true, - "description": "Playback's identifier.", - "type": "string" + "allowableValues": { + "valueType": "LIST", + "values": [ + "queued", + "playing", + "complete" + ] + } } } } |