You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
308 lines
18 KiB
308 lines
18 KiB
using System;
|
|
using Jellyfin.Api.Constants;
|
|
using MediaBrowser.Controller.Dto;
|
|
using MediaBrowser.Controller.Library;
|
|
using MediaBrowser.Model.Dto;
|
|
using MediaBrowser.Model.Globalization;
|
|
using MediaBrowser.Model.Querying;
|
|
using Microsoft.AspNetCore.Authorization;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Mvc;
|
|
using Microsoft.Extensions.Logging;
|
|
|
|
namespace Jellyfin.Api.Controllers
|
|
{
|
|
/// <summary>
|
|
/// The trailers controller.
|
|
/// </summary>
|
|
[Authorize(Policy = Policies.DefaultAuthorization)]
|
|
public class TrailersController : BaseJellyfinApiController
|
|
{
|
|
private readonly IUserManager _userManager;
|
|
private readonly ILibraryManager _libraryManager;
|
|
private readonly ILogger<ItemsController> _logger;
|
|
private readonly IDtoService _dtoService;
|
|
private readonly ILocalizationManager _localizationManager;
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="TrailersController"/> class.
|
|
/// </summary>
|
|
/// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
|
|
/// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
|
|
/// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
|
|
/// <param name="dtoService">Instance of the <see cref="IDtoService"/> interface.</param>
|
|
/// <param name="localizationManager">Instance of the <see cref="ILocalizationManager"/> interface.</param>
|
|
public TrailersController(
|
|
ILoggerFactory loggerFactory,
|
|
IUserManager userManager,
|
|
ILibraryManager libraryManager,
|
|
IDtoService dtoService,
|
|
ILocalizationManager localizationManager)
|
|
{
|
|
_userManager = userManager;
|
|
_libraryManager = libraryManager;
|
|
_dtoService = dtoService;
|
|
_localizationManager = localizationManager;
|
|
_logger = loggerFactory.CreateLogger<ItemsController>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Finds movies and trailers similar to a given trailer.
|
|
/// </summary>
|
|
/// <param name="userId">The user id.</param>
|
|
/// <param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
/// <param name="hasThemeSong">Optional filter by items with theme songs.</param>
|
|
/// <param name="hasThemeVideo">Optional filter by items with theme videos.</param>
|
|
/// <param name="hasSubtitles">Optional filter by items with subtitles.</param>
|
|
/// <param name="hasSpecialFeature">Optional filter by items with special features.</param>
|
|
/// <param name="hasTrailer">Optional filter by items with trailers.</param>
|
|
/// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
|
|
/// <param name="parentIndexNumber">Optional filter by parent index number.</param>
|
|
/// <param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param>
|
|
/// <param name="isHd">Optional filter by items that are HD or not.</param>
|
|
/// <param name="is4K">Optional filter by items that are 4K or not.</param>
|
|
/// <param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.</param>
|
|
/// <param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. This allows multiple, comma delimeted.</param>
|
|
/// <param name="isMissing">Optional filter by items that are missing episodes or not.</param>
|
|
/// <param name="isUnaired">Optional filter by items that are unaired episodes or not.</param>
|
|
/// <param name="minCommunityRating">Optional filter by minimum community rating.</param>
|
|
/// <param name="minCriticRating">Optional filter by minimum critic rating.</param>
|
|
/// <param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param>
|
|
/// <param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param>
|
|
/// <param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.</param>
|
|
/// <param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param>
|
|
/// <param name="hasOverview">Optional filter by items that have an overview or not.</param>
|
|
/// <param name="hasImdbId">Optional filter by items that have an imdb id or not.</param>
|
|
/// <param name="hasTmdbId">Optional filter by items that have a tmdb id or not.</param>
|
|
/// <param name="hasTvdbId">Optional filter by items that have a tvdb id or not.</param>
|
|
/// <param name="excludeItemIds">Optional. If specified, results will be filtered by exxcluding item ids. This allows multiple, comma delimeted.</param>
|
|
/// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped from the results.</param>
|
|
/// <param name="limit">Optional. The maximum number of records to return.</param>
|
|
/// <param name="recursive">When searching within folders, this determines whether or not the search will be recursive. true/false.</param>
|
|
/// <param name="searchTerm">Optional. Filter based on a search term.</param>
|
|
/// <param name="sortOrder">Sort Order - Ascending,Descending.</param>
|
|
/// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</param>
|
|
/// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.</param>
|
|
/// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.</param>
|
|
/// <param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes.</param>
|
|
/// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
|
|
/// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
|
|
/// <param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.</param>
|
|
/// <param name="sortBy">Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.</param>
|
|
/// <param name="isPlayed">Optional filter by items that are played, or not.</param>
|
|
/// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.</param>
|
|
/// <param name="enableUserData">Optional, include user data.</param>
|
|
/// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
|
|
/// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
|
|
/// <param name="person">Optional. If specified, results will be filtered to include only those containing the specified person.</param>
|
|
/// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the specified person id.</param>
|
|
/// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited.</param>
|
|
/// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="artistIds">Optional. If specified, results will be filtered to include only those containing the specified artist id.</param>
|
|
/// <param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing the specified album artist id.</param>
|
|
/// <param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those containing the specified contributing artist id.</param>
|
|
/// <param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.</param>
|
|
/// <param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.</param>
|
|
/// <param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param>
|
|
/// <param name="isLocked">Optional filter by items that are locked.</param>
|
|
/// <param name="isPlaceHolder">Optional filter by items that are placeholders.</param>
|
|
/// <param name="hasOfficialRating">Optional filter by items that have official ratings.</param>
|
|
/// <param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param>
|
|
/// <param name="minWidth">Optional. Filter by the minimum width of the item.</param>
|
|
/// <param name="minHeight">Optional. Filter by the minimum height of the item.</param>
|
|
/// <param name="maxWidth">Optional. Filter by the maximum width of the item.</param>
|
|
/// <param name="maxHeight">Optional. Filter by the maximum height of the item.</param>
|
|
/// <param name="is3D">Optional filter by items that are 3D, or not.</param>
|
|
/// <param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimeted.</param>
|
|
/// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a given input string.</param>
|
|
/// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</param>
|
|
/// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</param>
|
|
/// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple, pipe delimeted.</param>
|
|
/// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
|
|
/// <param name="enableImages">Optional, include image information in output.</param>
|
|
/// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the trailers.</returns>
|
|
[HttpGet("/Trailers")]
|
|
[ProducesResponseType(StatusCodes.Status200OK)]
|
|
public ActionResult<QueryResult<BaseItemDto>> GetTrailers(
|
|
[FromQuery] Guid? userId,
|
|
[FromQuery] string? maxOfficialRating,
|
|
[FromQuery] bool? hasThemeSong,
|
|
[FromQuery] bool? hasThemeVideo,
|
|
[FromQuery] bool? hasSubtitles,
|
|
[FromQuery] bool? hasSpecialFeature,
|
|
[FromQuery] bool? hasTrailer,
|
|
[FromQuery] string? adjacentTo,
|
|
[FromQuery] int? parentIndexNumber,
|
|
[FromQuery] bool? hasParentalRating,
|
|
[FromQuery] bool? isHd,
|
|
[FromQuery] bool? is4K,
|
|
[FromQuery] string? locationTypes,
|
|
[FromQuery] string? excludeLocationTypes,
|
|
[FromQuery] bool? isMissing,
|
|
[FromQuery] bool? isUnaired,
|
|
[FromQuery] double? minCommunityRating,
|
|
[FromQuery] double? minCriticRating,
|
|
[FromQuery] DateTime? minPremiereDate,
|
|
[FromQuery] DateTime? minDateLastSaved,
|
|
[FromQuery] DateTime? minDateLastSavedForUser,
|
|
[FromQuery] DateTime? maxPremiereDate,
|
|
[FromQuery] bool? hasOverview,
|
|
[FromQuery] bool? hasImdbId,
|
|
[FromQuery] bool? hasTmdbId,
|
|
[FromQuery] bool? hasTvdbId,
|
|
[FromQuery] string? excludeItemIds,
|
|
[FromQuery] int? startIndex,
|
|
[FromQuery] int? limit,
|
|
[FromQuery] bool? recursive,
|
|
[FromQuery] string? searchTerm,
|
|
[FromQuery] string? sortOrder,
|
|
[FromQuery] string? parentId,
|
|
[FromQuery] string? fields,
|
|
[FromQuery] string? excludeItemTypes,
|
|
[FromQuery] string? filters,
|
|
[FromQuery] bool? isFavorite,
|
|
[FromQuery] string? mediaTypes,
|
|
[FromQuery] string? imageTypes,
|
|
[FromQuery] string? sortBy,
|
|
[FromQuery] bool? isPlayed,
|
|
[FromQuery] string? genres,
|
|
[FromQuery] string? officialRatings,
|
|
[FromQuery] string? tags,
|
|
[FromQuery] string? years,
|
|
[FromQuery] bool? enableUserData,
|
|
[FromQuery] int? imageTypeLimit,
|
|
[FromQuery] string? enableImageTypes,
|
|
[FromQuery] string? person,
|
|
[FromQuery] string? personIds,
|
|
[FromQuery] string? personTypes,
|
|
[FromQuery] string? studios,
|
|
[FromQuery] string? artists,
|
|
[FromQuery] string? excludeArtistIds,
|
|
[FromQuery] string? artistIds,
|
|
[FromQuery] string? albumArtistIds,
|
|
[FromQuery] string? contributingArtistIds,
|
|
[FromQuery] string? albums,
|
|
[FromQuery] string? albumIds,
|
|
[FromQuery] string? ids,
|
|
[FromQuery] string? videoTypes,
|
|
[FromQuery] string? minOfficialRating,
|
|
[FromQuery] bool? isLocked,
|
|
[FromQuery] bool? isPlaceHolder,
|
|
[FromQuery] bool? hasOfficialRating,
|
|
[FromQuery] bool? collapseBoxSetItems,
|
|
[FromQuery] int? minWidth,
|
|
[FromQuery] int? minHeight,
|
|
[FromQuery] int? maxWidth,
|
|
[FromQuery] int? maxHeight,
|
|
[FromQuery] bool? is3D,
|
|
[FromQuery] string? seriesStatus,
|
|
[FromQuery] string? nameStartsWithOrGreater,
|
|
[FromQuery] string? nameStartsWith,
|
|
[FromQuery] string? nameLessThan,
|
|
[FromQuery] string? studioIds,
|
|
[FromQuery] string? genreIds,
|
|
[FromQuery] bool enableTotalRecordCount = true,
|
|
[FromQuery] bool? enableImages = true)
|
|
{
|
|
var includeItemTypes = "Trailer";
|
|
|
|
return new ItemsController(
|
|
_userManager,
|
|
_libraryManager,
|
|
_localizationManager,
|
|
_dtoService,
|
|
_logger)
|
|
.GetItems(
|
|
userId,
|
|
userId,
|
|
maxOfficialRating,
|
|
hasThemeSong,
|
|
hasThemeVideo,
|
|
hasSubtitles,
|
|
hasSpecialFeature,
|
|
hasTrailer,
|
|
adjacentTo,
|
|
parentIndexNumber,
|
|
hasParentalRating,
|
|
isHd,
|
|
is4K,
|
|
locationTypes,
|
|
excludeLocationTypes,
|
|
isMissing,
|
|
isUnaired,
|
|
minCommunityRating,
|
|
minCriticRating,
|
|
minPremiereDate,
|
|
minDateLastSaved,
|
|
minDateLastSavedForUser,
|
|
maxPremiereDate,
|
|
hasOverview,
|
|
hasImdbId,
|
|
hasTmdbId,
|
|
hasTvdbId,
|
|
excludeItemIds,
|
|
startIndex,
|
|
limit,
|
|
recursive,
|
|
searchTerm,
|
|
sortOrder,
|
|
parentId,
|
|
fields,
|
|
excludeItemTypes,
|
|
includeItemTypes,
|
|
filters,
|
|
isFavorite,
|
|
mediaTypes,
|
|
imageTypes,
|
|
sortBy,
|
|
isPlayed,
|
|
genres,
|
|
officialRatings,
|
|
tags,
|
|
years,
|
|
enableUserData,
|
|
imageTypeLimit,
|
|
enableImageTypes,
|
|
person,
|
|
personIds,
|
|
personTypes,
|
|
studios,
|
|
artists,
|
|
excludeArtistIds,
|
|
artistIds,
|
|
albumArtistIds,
|
|
contributingArtistIds,
|
|
albums,
|
|
albumIds,
|
|
ids,
|
|
videoTypes,
|
|
minOfficialRating,
|
|
isLocked,
|
|
isPlaceHolder,
|
|
hasOfficialRating,
|
|
collapseBoxSetItems,
|
|
minWidth,
|
|
minHeight,
|
|
maxWidth,
|
|
maxHeight,
|
|
is3D,
|
|
seriesStatus,
|
|
nameStartsWithOrGreater,
|
|
nameStartsWith,
|
|
nameLessThan,
|
|
studioIds,
|
|
genreIds,
|
|
enableTotalRecordCount,
|
|
enableImages);
|
|
}
|
|
}
|
|
}
|