Playbacks¶
| Method | Path (Parameters are case-sensitive) | Return Model | Summary |
|---|---|---|---|
| GET | /playbacks/{playbackId} | Playback | Get a playback's details. |
| DELETE | /playbacks/{playbackId} | void | Stop a playback. |
| POST | /playbacks/{playbackId}/control | void | Control a playback. |
get¶
GET /playbacks/{playbackId}¶
Get a playback's details.
Path parameters¶
Parameters are case-sensitive. * playbackId: string - Playback's id
Error Responses¶
- 404 - The playback cannot be found
stop¶
DELETE /playbacks/{playbackId}¶
Stop a playback.
Path parameters¶
Parameters are case-sensitive. * playbackId: string - Playback's id
Error Responses¶
- 404 - The playback cannot be found
control¶
POST /playbacks/{playbackId}/control¶
Control a playback.
Path parameters¶
Parameters are case-sensitive. * playbackId: string - Playback's id
Query parameters¶
- operation: string - (required) Operation to perform on the playback.
- Allowed values: restart, pause, unpause, reverse, forward
Error Responses¶
- 400 - The provided operation parameter was invalid
- 404 - The playback cannot be found
- 409 - The operation cannot be performed in the playback's current state