...
Recordings can be searched using the search recordings endpoint. If no search string is provided, then all recordings for the profile are returned. Note that the response is paginated. The recording search endpoint accepts a number of filters to limit the objects returned. The series.id filter accepts a special value "null" which matches only recordings for programs with no series (e.g. movies).
Recording groups
For an improved user experience, a grouping API is provided to allow clients to display groups of recordings to the user without having to fetch all recording data at once.
Endpoints overview
| Endpoint | HTTP method | Purpose |
|---|---|---|
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/recording_groups | GET | See all recording groups |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/recording_groups/{recording_group_id}/recordings | GET | (Deprecated) See all recordings in a group |
/api/recordings/v4/user_profiles/{user_profile_id}/recordings/recording_groups/ungrouped/recordings | GET | (Deprecated) See all recordings not in any group |
The client can obtain a list of recording groups available to their profile by calling the recording groups endpoint. Recordings are grouped by series by default, but the grouping can be defined with the group_by parameter. The group_by parameter accepts series_id, channel_id or both combined. When both series_id and channel_id are combined, the endpoint will return one group per unique series_id-channel_id combination. Filters are available for favourite, starts_before, starts_after, ends_before, ends_after. The filters does not filter the groups themselves, but the recordings contained in the groups, i.e. the groups are returned as if the filtered recordings do not exist. Recordings that do not fit into any group are not included in the response.
The contents of each group can be obtained from the search recordings endpoint using appropriate filters.
...
| Info |
|---|
Automated recordings are only rules for the system to automatically keep adding recordings to the particular series along they get populated to the channel's program schedule. This means that the user's recording quota is not taken into account when adding the automated recording request. The automated recording request will keep on running as a background process if the user's recording quota allows it. If the quota gets full, the process will not add new recordings anymore. Respectively when some quota is freed, the process will continue adding the automated recordings based on the user's stored automated recording rules. |
Exceeded user recording limit
There are two available strategies to handling exceeding of recording limit.
By default, when a user reaches the recording limit, the system blocks new recordings being added to the user (and its profiles), until user free up enough space for the new recording.
Alternatively, it is possible to configure the system to auto delete exceeded recordings. In this mode, instead of blocking new recordings, a cleaner is scheduled to run daily. The cleaner automatically deletes users' exceeded recordings until they are again below the limit.
Delete priority: Firstly non-favorite recordings from oldest to newest. If threshold is not met, then favorite recordings are deleted from oldest to newest.
Postman collection
| View file | ||||
|---|---|---|---|---|
|