JEjellyfin
LiveTv

Gets live tv recording series.

get/LiveTv/Recordings/Series

Request

Query parameters

channelIdstring nullable

Optional. Filter by channel id.

userIdstring uuid nullable

Optional. Filter by user and attach user data.

groupIdstring nullable

Optional. Filter by recording group.

startIndexinteger nullable

Optional. The record index to start at. All items with a lower index will be dropped from the results.

limitinteger nullable

Optional. The maximum number of records to return.

status'New' | 'InProgress' | 'Completed' | 'Cancelled' | 'ConflictedOk' | 'ConflictedNotOk' | 'Error'

Optional. Filter by recording status.

isInProgressboolean nullable

Optional. Filter by recordings that are in progress, or not.

seriesTimerIdstring nullable

Optional. Filter by recordings belonging to a series timer.

enableImagesboolean nullable

Optional. Include image information in output.

imageTypeLimitinteger nullable

Optional. The max number of images to return, per image type.

enableImageTypesImageType[] nullable

Optional. The image types to include in the output.

fieldsItemFields[] nullable

Optional. Specify additional fields of information to return in the output.

enableUserDataboolean nullable

Optional. Include user data.

enableTotalRecordCountboolean

Optional. Return total record count.

Response

Live tv recordings returned.

TotalRecordCountinteger

The total number of records available.

StartIndexinteger

The index of the first record in Items.

Changes

No recorded changes to this operation across all 1 revision of this API.