...
| 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
Endpoints Overview
| Endpoint | HTTP method | Purpose |
|---|---|---|
/api/recordings/v4/user_profiles/{user_profile_id}/recordings | GET | Search for recordings belonging to user profile |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings | POST | Create a new recording |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/{recording_id} | PATCH | Update a recording |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/{recording_id} | DELETE | Remove a recording |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/batch_delete_recordings | POST | Remove multiple recordings in batch |
/api/recordings/v4/user_profiles/{user_profile_id}/recorded_broadcast_slots | GET | Get all recorded broadcast slots for user profile |
/api/recordings/v4/user/{user_id}/storage_quota | GET | Get user's storage quota |
/api/recordings/v4/most_popular/{period} | GET | Get most recorded broadcast slots for a given period |
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:
...
| Warning |
|---|
Not implemented yet |
Endpoints overview
| Endpoint | HTTP method | Purpose |
|---|---|---|
/api/recordings/v4/user_profiles/{user_profile_id}/auto_recording_requests | GET | View current auto-recording requests |
/api/recordings/v4/user_profiles/{user_profile_id}/auto_recording_requests | POST | Create new auto-recording request |
/api/recordings/v4/user_profiles/{user_profile_id}/auto_recording_requests/{recording_request_id} | PATCH | Update auto-recording request |
/api/recordings/v4/user_profiles/{user_profile_id}/auto_recording_requests/{recording_request_id} | DELETE | Delete auto-recording request |
If the user wishes to have recordings created automatically for them as they become available, they can do so using the automated recording feature. To do so, they must first 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.
...