@jellyfin/sdk
    Preparing search index...

    Interface TvShowsApiGetEpisodesRequest

    Request parameters for getEpisodes operation in TvShowsApi.

    TvShowsApiGetEpisodesRequest

    interface TvShowsApiGetEpisodesRequest {
        adjacentTo?: string;
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        fields?: ItemFields[];
        imageTypeLimit?: number;
        isMissing?: boolean;
        limit?: number;
        season?: number;
        seasonId?: string;
        seriesId: string;
        sortBy?: ItemSortBy;
        startIndex?: number;
        startItemId?: string;
        userId?: string;
    }
    Index

    Properties

    adjacentTo? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isMissing? limit? season? seasonId? seriesId sortBy? startIndex? startItemId? userId?

    Properties

    adjacentTo?: string

    Optional. Return items that are siblings of a supplied item.

    TvShowsApiGetEpisodes

    enableImages?: boolean

    Optional, include image information in output.

    TvShowsApiGetEpisodes

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    TvShowsApiGetEpisodes

    enableUserData?: boolean

    Optional. Include user data.

    TvShowsApiGetEpisodes

    fields?: ItemFields[]

    Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

    TvShowsApiGetEpisodes

    imageTypeLimit?: number

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

    TvShowsApiGetEpisodes

    isMissing?: boolean

    Optional. Filter by items that are missing episodes or not.

    TvShowsApiGetEpisodes

    limit?: number

    Optional. The maximum number of records to return.

    TvShowsApiGetEpisodes

    season?: number

    Optional filter by season number.

    TvShowsApiGetEpisodes

    seasonId?: string

    Optional. Filter by season id.

    TvShowsApiGetEpisodes

    seriesId: string

    The series id.

    TvShowsApiGetEpisodes

    sortBy?: ItemSortBy

    Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

    TvShowsApiGetEpisodes

    startIndex?: number

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

    TvShowsApiGetEpisodes

    startItemId?: string

    Optional. Skip through the list until a given item is found.

    TvShowsApiGetEpisodes

    userId?: string

    The user id.

    TvShowsApiGetEpisodes

    Settings

    Member Visibility

    On This Page

    Properties