Remix Playlist


Remix Playlists are playlists of content which should be played out in order. Each playlist item is a given Event in the system.

Note: Remix Playlist API has been deprecated in favour of using the Compose API. Existing usage of Remix remains available and unchanged.

Remix Playlist Object

[
  {
    "Id": "241f1bf1-f199-4e19-8f6e-188f71c7dcdf",
    "EventId": "5dd715c4-9935-55d4-9f5d-1481465ade17",
    "Order": "2017-11-09T11:52:43Z",
    "Duration": "00:03:10.3230000",
    "Skippable": true
  },
  {
    "Id": "80747170-1606-41c1-a48c-5bce51f07c53",
    "EventId": "4efcaec6-7a84-5efb-b48f-1e86db87426a",
    "Order": "2017-11-09T11:52:42Z",
    "Duration": "00:00:05.2500000",
    "Skippable": false
  }
]

Supported Actions

POST /remix/

Add a new Remix Playlist.

Request Body:

{
    "Id": "5dfcaec6-7a84-5efb-b48f-1e86db87426a",
    "title": "The title",
    "private": false,
    "drm": false
    "referenceId": "vid-633136f5-d548-458c-ab1c-9d23462f4034-chris",
    "remixflowId": "1dfcaec6-7a84-5efb-b48f-1e86db87426a",
    "webhooks": [
        {
            "webHookUrl": "https://requestb.in/1iw6pd01",
            "useHttpBasicAuthentication": true,
            "useJsonBody": true
        }
    ],
    "playlistItems": [
        {
            "eventId": "4efcaec6-7a84-5efb-b48f-1e86db87426a",
            "duration": "00:00:05.250",
            "skippable": false
        },
        {
            "eventId": "5DD715C4-9935-55D4-9F5D-1481465ADE17",
            "duration": "00:03:10.323",
            "skippable": true
        }
    ]
}

If an Id is not specified, one will be generated for the Playlist.

Response: 201 Created


PUT /remix/{id}

Update a Remix Playlist.

Request Body:

{
    "id": "5dfcaec6-7a84-5efb-b48f-1e86db87426a",
    "title": "The title",
    "drm": false,
    "remixflowId": "1dfcaec6-7a84-5efb-b48f-1e86db87426a",
    "webhooks": [
        {
            "webHookUrl": "https://requestb.in/1iw6pd01",
            "useHttpBasicAuthentication": true,
            "useJsonBody": true
        }
    ],
    "playlistItems": [
        {
            "eventId": "4efcaec6-7a84-5efb-b48f-1e86db87426a",
            "duration": "00:00:05.250",
            "skippable": false
        }
    ]
}

Response: 200 OK


PUT /remix/process/{id}

Process a Remix Playlist.

Response: 200 OK


GET /remix/{id}

Get a Remix Playlist by Id.

Response: 200 OK and JSON containing the Remix Playlist object.


DEL /remix/{id}

Delete a Remix Playlist by Id.

Response: 410 Gone