Introduction
Users can request recordings of programs that air on channels that provide the recording service. Users can also request that new recordings are made automatically on their behalf as they become available in the channel's broadcast schedule. Recordings are owned by individual user profiles, but all user profiles of one user account share a common recording quota and a common set of licenses to record.
The recording API v4 spec can be viewed at Profile recordings
Entities overview
| Entity | Purpose |
|---|---|
| Broadcast slot | This entity originates from EPG API v4. It identifies a time slot on a channel where a program is aired. If the time slot is in the future, it may change or be removed depending on the broadcast schedule for that particular channel. |
| Recording | Specifies recording of one broadcast slot for one user profile. It may be created explicitly by the user or automatically as part of an automated recording request. The recorded broadcast slot may be in the future or in the past, and as such it may or may not be available for streaming. |
| Recording Group | A group of Recordings. Recordings are automatically grouped by series. If a recording has no series, then they are part of the special "ungrouped" group. |
| Automated Recording Request | A request by the user to automatically create recordings for new Broadcast slots as they become available. |
Recording
A user can create a new recording for their profile by calling the create recording endpoint. A user may record a program if the following are true:
...
Individual recordings can be deleted by calling the delete recording endpoint, or in a batch of multiple recordings by calling the batch delete recordings endpoint. TODO: update the link
Streaming
If a recording is streamable, the available stream URLs can be obtained by calling the streams API with the ID of the Recording.
Recording search
Recordings can be searched using the search recordings endpoint. If no search string is provided, then all recordings for the profile are returned.
Recording groups
Recordings are automatically grouped by series. The client can obtain a list of recording groups available to their profile by calling the recording groups endpoint.
...
The client can filter the output of these APIs by favourite.
Automated recording
If the user wishes to have recordings created automatically for them as they become available, they can create an Automated recording request by calling the create auto recording request endpoint. Users can obtain a list of their current auto recording requests by calling the get auto recording requests endpoint. Users can update those requests by calling the update recording request endpoint, and delete them using the delete auto recording request endpoint.
...