@jellyfin/sdk
    Preparing search index...

    Interface TrailersApiGetTrailersRequest

    Request parameters for getTrailers operation in TrailersApi.

    TrailersApiGetTrailersRequest

    interface TrailersApiGetTrailersRequest {
        adjacentTo?: string;
        albumArtistIds?: string[];
        albumIds?: string[];
        albums?: string[];
        artistIds?: string[];
        artists?: string[];
        collapseBoxSetItems?: boolean;
        contributingArtistIds?: string[];
        enableImages?: boolean;
        enableImageTypes?: ImageType[];
        enableTotalRecordCount?: boolean;
        enableUserData?: boolean;
        excludeArtistIds?: string[];
        excludeItemIds?: string[];
        excludeItemTypes?: BaseItemKind[];
        excludeLocationTypes?: LocationType[];
        fields?: ItemFields[];
        filters?: ItemFilter[];
        genreIds?: string[];
        genres?: string[];
        hasImdbId?: boolean;
        hasOfficialRating?: boolean;
        hasOverview?: boolean;
        hasParentalRating?: boolean;
        hasSpecialFeature?: boolean;
        hasSubtitles?: boolean;
        hasThemeSong?: boolean;
        hasThemeVideo?: boolean;
        hasTmdbId?: boolean;
        hasTrailer?: boolean;
        hasTvdbId?: boolean;
        ids?: string[];
        imageTypeLimit?: number;
        imageTypes?: ImageType[];
        is3D?: boolean;
        is4K?: boolean;
        isFavorite?: boolean;
        isHd?: boolean;
        isKids?: boolean;
        isLocked?: boolean;
        isMissing?: boolean;
        isMovie?: boolean;
        isNews?: boolean;
        isPlaceHolder?: boolean;
        isPlayed?: boolean;
        isSeries?: boolean;
        isSports?: boolean;
        isUnaired?: boolean;
        limit?: number;
        locationTypes?: LocationType[];
        maxHeight?: number;
        maxOfficialRating?: string;
        maxPremiereDate?: string;
        maxWidth?: number;
        mediaTypes?: MediaType[];
        minCommunityRating?: number;
        minCriticRating?: number;
        minDateLastSaved?: string;
        minDateLastSavedForUser?: string;
        minHeight?: number;
        minOfficialRating?: string;
        minPremiereDate?: string;
        minWidth?: number;
        nameLessThan?: string;
        nameStartsWith?: string;
        nameStartsWithOrGreater?: string;
        officialRatings?: string[];
        parentId?: string;
        parentIndexNumber?: number;
        person?: string;
        personIds?: string[];
        personTypes?: string[];
        recursive?: boolean;
        searchTerm?: string;
        seriesStatus?: SeriesStatus[];
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder[];
        startIndex?: number;
        studioIds?: string[];
        studios?: string[];
        tags?: string[];
        userId?: string;
        videoTypes?: VideoType[];
        years?: number[];
    }
    Index

    Properties

    adjacentTo? albumArtistIds? albumIds? albums? artistIds? artists? collapseBoxSetItems? contributingArtistIds? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeArtistIds? excludeItemIds? excludeItemTypes? excludeLocationTypes? fields? filters? genreIds? genres? hasImdbId? hasOfficialRating? hasOverview? hasParentalRating? hasSpecialFeature? hasSubtitles? hasThemeSong? hasThemeVideo? hasTmdbId? hasTrailer? hasTvdbId? ids? imageTypeLimit? imageTypes? is3D? is4K? isFavorite? isHd? isKids? isLocked? isMissing? isMovie? isNews? isPlaceHolder? isPlayed? isSeries? isSports? isUnaired? limit? locationTypes? maxHeight? maxOfficialRating? maxPremiereDate? maxWidth? mediaTypes? minCommunityRating? minCriticRating? minDateLastSaved? minDateLastSavedForUser? minHeight? minOfficialRating? minPremiereDate? minWidth? nameLessThan? nameStartsWith? nameStartsWithOrGreater? officialRatings? parentId? parentIndexNumber? person? personIds? personTypes? recursive? searchTerm? seriesStatus? sortBy? sortOrder? startIndex? studioIds? studios? tags? userId? videoTypes? years?

    Properties

    adjacentTo?: string

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

    TrailersApiGetTrailers

    albumArtistIds?: string[]

    Optional. If specified, results will be filtered to include only those containing the specified album artist id.

    TrailersApiGetTrailers

    albumIds?: string[]

    Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    albums?: string[]

    Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    artistIds?: string[]

    Optional. If specified, results will be filtered to include only those containing the specified artist id.

    TrailersApiGetTrailers

    artists?: string[]

    Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    collapseBoxSetItems?: boolean

    Whether or not to hide items behind their boxsets.

    TrailersApiGetTrailers

    contributingArtistIds?: string[]

    Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.

    TrailersApiGetTrailers

    enableImages?: boolean

    Optional, include image information in output.

    TrailersApiGetTrailers

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    TrailersApiGetTrailers

    enableTotalRecordCount?: boolean

    Optional. Enable the total record count.

    TrailersApiGetTrailers

    enableUserData?: boolean

    Optional, include user data.

    TrailersApiGetTrailers

    excludeArtistIds?: string[]

    Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    excludeItemIds?: string[]

    Optional. If specified, results will be filtered by excluding item ids. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    excludeItemTypes?: BaseItemKind[]

    Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    excludeLocationTypes?: LocationType[]

    Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    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.

    TrailersApiGetTrailers

    filters?: ItemFilter[]

    Optional. Specify additional filters to apply. This allows multiple, comma delimited. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.

    TrailersApiGetTrailers

    genreIds?: string[]

    Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    genres?: string[]

    Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    hasImdbId?: boolean

    Optional filter by items that have an IMDb id or not.

    TrailersApiGetTrailers

    hasOfficialRating?: boolean

    Optional filter by items that have official ratings.

    TrailersApiGetTrailers

    hasOverview?: boolean

    Optional filter by items that have an overview or not.

    TrailersApiGetTrailers

    hasParentalRating?: boolean

    Optional filter by items that have or do not have a parental rating.

    TrailersApiGetTrailers

    hasSpecialFeature?: boolean

    Optional filter by items with special features.

    TrailersApiGetTrailers

    hasSubtitles?: boolean

    Optional filter by items with subtitles.

    TrailersApiGetTrailers

    hasThemeSong?: boolean

    Optional filter by items with theme songs.

    TrailersApiGetTrailers

    hasThemeVideo?: boolean

    Optional filter by items with theme videos.

    TrailersApiGetTrailers

    hasTmdbId?: boolean

    Optional filter by items that have a TMDb id or not.

    TrailersApiGetTrailers

    hasTrailer?: boolean

    Optional filter by items with trailers.

    TrailersApiGetTrailers

    hasTvdbId?: boolean

    Optional filter by items that have a TVDb id or not.

    TrailersApiGetTrailers

    ids?: string[]

    Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    imageTypeLimit?: number

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

    TrailersApiGetTrailers

    imageTypes?: ImageType[]

    Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    is3D?: boolean

    Optional filter by items that are 3D, or not.

    TrailersApiGetTrailers

    is4K?: boolean

    Optional filter by items that are 4K or not.

    TrailersApiGetTrailers

    isFavorite?: boolean

    Optional filter by items that are marked as favorite, or not.

    TrailersApiGetTrailers

    isHd?: boolean

    Optional filter by items that are HD or not.

    TrailersApiGetTrailers

    isKids?: boolean

    Optional filter for live tv kids.

    TrailersApiGetTrailers

    isLocked?: boolean

    Optional filter by items that are locked.

    TrailersApiGetTrailers

    isMissing?: boolean

    Optional filter by items that are missing episodes or not.

    TrailersApiGetTrailers

    isMovie?: boolean

    Optional filter for live tv movies.

    TrailersApiGetTrailers

    isNews?: boolean

    Optional filter for live tv news.

    TrailersApiGetTrailers

    isPlaceHolder?: boolean

    Optional filter by items that are placeholders.

    TrailersApiGetTrailers

    isPlayed?: boolean

    Optional filter by items that are played, or not.

    TrailersApiGetTrailers

    isSeries?: boolean

    Optional filter for live tv series.

    TrailersApiGetTrailers

    isSports?: boolean

    Optional filter for live tv sports.

    TrailersApiGetTrailers

    isUnaired?: boolean

    Optional filter by items that are unaired episodes or not.

    TrailersApiGetTrailers

    limit?: number

    Optional. The maximum number of records to return.

    TrailersApiGetTrailers

    locationTypes?: LocationType[]

    Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    maxHeight?: number

    Optional. Filter by the maximum height of the item.

    TrailersApiGetTrailers

    maxOfficialRating?: string

    Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).

    TrailersApiGetTrailers

    maxPremiereDate?: string

    Optional. The maximum premiere date. Format = ISO.

    TrailersApiGetTrailers

    maxWidth?: number

    Optional. Filter by the maximum width of the item.

    TrailersApiGetTrailers

    mediaTypes?: MediaType[]

    Optional filter by MediaType. Allows multiple, comma delimited.

    TrailersApiGetTrailers

    minCommunityRating?: number

    Optional filter by minimum community rating.

    TrailersApiGetTrailers

    minCriticRating?: number

    Optional filter by minimum critic rating.

    TrailersApiGetTrailers

    minDateLastSaved?: string

    Optional. The minimum last saved date. Format = ISO.

    TrailersApiGetTrailers

    minDateLastSavedForUser?: string

    Optional. The minimum last saved date for the current user. Format = ISO.

    TrailersApiGetTrailers

    minHeight?: number

    Optional. Filter by the minimum height of the item.

    TrailersApiGetTrailers

    minOfficialRating?: string

    Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).

    TrailersApiGetTrailers

    minPremiereDate?: string

    Optional. The minimum premiere date. Format = ISO.

    TrailersApiGetTrailers

    minWidth?: number

    Optional. Filter by the minimum width of the item.

    TrailersApiGetTrailers

    nameLessThan?: string

    Optional filter by items whose name is equally or lesser than a given input string.

    TrailersApiGetTrailers

    nameStartsWith?: string

    Optional filter by items whose name is sorted equally than a given input string.

    TrailersApiGetTrailers

    nameStartsWithOrGreater?: string

    Optional filter by items whose name is sorted equally or greater than a given input string.

    TrailersApiGetTrailers

    officialRatings?: string[]

    Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    parentId?: string

    Specify this to localize the search to a specific item or folder. Omit to use the root.

    TrailersApiGetTrailers

    parentIndexNumber?: number

    Optional filter by parent index number.

    TrailersApiGetTrailers

    person?: string

    Optional. If specified, results will be filtered to include only those containing the specified person.

    TrailersApiGetTrailers

    personIds?: string[]

    Optional. If specified, results will be filtered to include only those containing the specified person id.

    TrailersApiGetTrailers

    personTypes?: string[]

    Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.

    TrailersApiGetTrailers

    recursive?: boolean

    When searching within folders, this determines whether or not the search will be recursive. true/false.

    TrailersApiGetTrailers

    searchTerm?: string

    Optional. Filter based on a search term.

    TrailersApiGetTrailers

    seriesStatus?: SeriesStatus[]

    Optional filter by Series Status. Allows multiple, comma delimited.

    TrailersApiGetTrailers

    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.

    TrailersApiGetTrailers

    sortOrder?: SortOrder[]

    Sort Order - Ascending, Descending.

    TrailersApiGetTrailers

    startIndex?: number

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

    TrailersApiGetTrailers

    studioIds?: string[]

    Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    studios?: string[]

    Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    tags?: string[]

    Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimited.

    TrailersApiGetTrailers

    userId?: string

    The user id supplied as query parameter; this is required when not using an API key.

    TrailersApiGetTrailers

    videoTypes?: VideoType[]

    Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimited.

    TrailersApiGetTrailers

    years?: number[]

    Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimited.

    TrailersApiGetTrailers

    Settings

    Member Visibility

    On This Page

    Properties
    adjacentToalbumArtistIdsalbumIdsalbumsartistIdsartistscollapseBoxSetItemscontributingArtistIdsenableImagesenableImageTypesenableTotalRecordCountenableUserDataexcludeArtistIdsexcludeItemIdsexcludeItemTypesexcludeLocationTypesfieldsfiltersgenreIdsgenreshasImdbIdhasOfficialRatinghasOverviewhasParentalRatinghasSpecialFeaturehasSubtitleshasThemeSonghasThemeVideohasTmdbIdhasTrailerhasTvdbIdidsimageTypeLimitimageTypesis3Dis4KisFavoriteisHdisKidsisLockedisMissingisMovieisNewsisPlaceHolderisPlayedisSeriesisSportsisUnairedlimitlocationTypesmaxHeightmaxOfficialRatingmaxPremiereDatemaxWidthmediaTypesminCommunityRatingminCriticRatingminDateLastSavedminDateLastSavedForUserminHeightminOfficialRatingminPremiereDateminWidthnameLessThannameStartsWithnameStartsWithOrGreaterofficialRatingsparentIdparentIndexNumberpersonpersonIdspersonTypesrecursivesearchTermseriesStatussortBysortOrderstartIndexstudioIdsstudiostagsuserIdvideoTypesyears