Recording hooks
Receive notifications about the life cycle of a stream recording.
Dolby.io Real-time Streaming will send you the following webhooks about the life cycle of a stream recording:
- started: when recording of a stream has been started.
- completed: when the recording has been correctly processed and it is available for download on the Dashboard.
- error: when there has been an error processing the recording.
- deleted: when the recording has been deleted from the Dolby.io Real-time Streaming archive storage.
Recording started webhook
Dolby.io Real-time Streaming will trigger this webhook when a stream has been started to be recorded, the event name is started
.
Here is an example of the webhook body:
{
type: 'recordings',
event: 'started',
timestamp: 1639296462907,
data: {
recordFileId: 7975,
tokenId: 142366,
streamName: 'testy',
recordedOn: 1639296462755
}
}
Recording completed webhook
Dolby.io Real-time Streaming will trigger this webhook when the recording has been correctly processed and it is available for download on the Dashboard, the event name is completed
.
Here is an example of the webhook body:
{
type: 'recordings',
event: 'completed',
timestamp: 1639296471486,
data: {
recordFileId: 7975,
tokenId: 142366,
streamName: 'testy',
recordedOn: 1639296463000,
metadata: {
format: 'MPEG-4',
sizes: { concat: 92791, dash: 97934, thumbnails: 0 },
duration: 1,
tracks: [
{
type: 'video',
codec: 'H264',
bitrate: 2898391,
width: 640,
height: 360,
framerate: 29.97
},
{
type: 'audio',
codec: 'Opus',
bitrate: 100575,
channels: 2,
samplerate: 48000
}
]
}
}
}
Recording processing error webhook
Dolby.io Real-time Streaming will trigger this webhook when there has been an error processing the recording, the event name is error
.
Here is an example of the webhook body:
{
type: 'recordings',
event: 'error',
timestamp: 1639296471486,
data: {
recordFileId: 7975,
tokenId: 142366,
streamName: 'testy',
recordedOn: 1639296462755
}
}
Recording deleted webhook
Dolby.io Real-time Streaming will trigger this webhook when the recording has been deleted and the recorded file has been successfully erased from Dolby.io Real-time Streaming servers, the event name is deleted
.
Here is an example of the webhook body:
{
"type": "recordings",
"event": "deleted",
"timestamp": 1643053773667,
"data": {
"recordFileId": 7975,
"tokenId": 142366,
"streamName": "testy",
"recordedOn": 1639296462755,
"removedOn": 1643053773659
}
}
Updated 5 months ago