Archiver Streams

• Archiver Stream object
• Supported Actions
  • GET archiverstream
  • GET /archiverstream/{id}
  • DELETE /archiverstream/{id}

---

All POST and PUT calls require the Content-Type header to be set to application/json

---

Archiver Stream object

Property	Type	Nullable	Notes
id	int	No
profileId	string	No
captureId	string	No
startTime	UTC ISO 8601 string	No
endTime	UTC ISO 8601 string	No
expiresAt	UTC ISO 8601 string	Yes
ismUrl	string	No
uploaded	bool	No
createdAt	UTC ISO 8601 string	No
updatedAt	UTC ISO 8601 string	No
streamingFormats	string array	No	"HLS", "HDS", "DASH", "SMOOTH"[1]

[1] This is the same as the streamingFormats property of the Playout Profile object associated by profileId

Supported Actions

GET archiverstream

Get all Archiver Streams

Response Body: Array of Archiver Stream objects

Example Response Body:

[
    {
        "id": 42,
        "profileId": "MyProfile",
        "captureId": "MyCapture",
        "startTime": "2018-09-18T10:15:00Z",
        "endTime": "2018-09-18T10:20:00Z",
        "expiresAt": "2018-10-03T10:15:00Z",
        "ismUrl": "/srv/media/vuarchiver/MyCapture/1537265700_1537266000_MyCapture_MyProfile.ism",
        "uploaded": false,
        "createdAt": "2018-09-21T11:56:08Z",
        "updatedAt": "2018-09-21T11:56:08Z",
        "streamingFormats": [
            "HLS",
            "DASH",
            "SMOOTH",
            "HDS"
        ]
    },
    {
        "id": 43,
        "profileId": "MyProfile",
        "captureId": "MyCapture2",
        "startTime": "2018-09-26T12:50:00Z",
        "endTime": "2018-09-26T13:00:00Z",
        "expiresAt": "2018-10-04T12:50:00Z",
        "ismUrl": "/srv/media/vuarchiver/MyCapture2/1537966200_1537966800_MyCapture2_MyProfile.ism",
        "uploaded": false,
        "createdAt": "2018-09-27T04:51:07Z",
        "updatedAt": "2018-09-27T04:51:07Z",
        "streamingFormats": [
            "DASH",
            "HLS"
        ]
    }
]

---

GET /archiverstream/{id}

Get the Archiver Stream with the specified ID

Response Body: Archiver Stream object

Example Request:

archiverstream/42

Example Response Body:

{
    "id": 42,
    "profileId": "MyProfile",
    "captureId": "MyCapture",
    "startTime": "2018-09-18T10:15:00Z",
    "endTime": "2018-09-18T10:20:00Z",
    "expiresAt": "2018-10-03T10:15:00Z",
    "ismUrl": "/srv/media/vuarchiver/MyCapture/1537265700_1537266000_MyCapture_MyProfile.ism",
    "uploaded": false,
    "createdAt": "2018-09-21T11:56:08Z",
    "updatedAt": "2018-09-21T11:56:08Z",
    "streamingFormats": [
        "HLS",
        "DASH",
        "SMOOTH",
        "HDS"
    ]
}

---

DELETE /archiverstream/{id}

Delete the Archiver Stream with the specified ID

Response Body: The deleted Archiver Stream object

Example Request

archiverstream/42

Example Response Body:

{
    "id": 42,
    "profileId": "MyProfile",
    "captureId": "MyCapture",
    "startTime": "2018-09-18T10:15:00Z",
    "endTime": "2018-09-18T10:20:00Z",
    "expiresAt": "2018-10-03T10:15:00Z",
    "ismUrl": "/srv/media/vuarchiver/MyCapture/1537265700_1537266000_MyCapture_MyProfile.ism",
    "uploaded": false,
    "createdAt": "2018-09-21T11:56:08Z",
    "updatedAt": "2018-09-21T11:56:08Z",
    "streamingFormats": [
        "HLS",
        "DASH",
        "SMOOTH",
        "HDS"
    ]
}