< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.TrailersController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/TrailersController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 92
Coverable lines: 92
Total lines: 298
Line coverage: 0%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%210%
GetTrailers(...)100%210%

File(s)

/srv/git/jellyfin/Jellyfin.Api/Controllers/TrailersController.cs

#LineLine coverage
 1using System;
 2using Jellyfin.Api.ModelBinders;
 3using Jellyfin.Data.Enums;
 4using Jellyfin.Database.Implementations.Enums;
 5using MediaBrowser.Model.Dto;
 6using MediaBrowser.Model.Entities;
 7using MediaBrowser.Model.Querying;
 8using Microsoft.AspNetCore.Authorization;
 9using Microsoft.AspNetCore.Http;
 10using Microsoft.AspNetCore.Mvc;
 11
 12namespace Jellyfin.Api.Controllers;
 13
 14/// <summary>
 15/// The trailers controller.
 16/// </summary>
 17[Authorize]
 18public class TrailersController : BaseJellyfinApiController
 19{
 20    private readonly ItemsController _itemsController;
 21
 22    /// <summary>
 23    /// Initializes a new instance of the <see cref="TrailersController"/> class.
 24    /// </summary>
 25    /// <param name="itemsController">Instance of <see cref="ItemsController"/>.</param>
 026    public TrailersController(ItemsController itemsController)
 27    {
 028        _itemsController = itemsController;
 029    }
 30
 31    /// <summary>
 32    /// Finds movies and trailers similar to a given trailer.
 33    /// </summary>
 34    /// <param name="userId">The user id supplied as query parameter; this is required when not using an API key.</param
 35    /// <param name="maxOfficialRating">Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).</param>
 36    /// <param name="hasThemeSong">Optional filter by items with theme songs.</param>
 37    /// <param name="hasThemeVideo">Optional filter by items with theme videos.</param>
 38    /// <param name="hasSubtitles">Optional filter by items with subtitles.</param>
 39    /// <param name="hasSpecialFeature">Optional filter by items with special features.</param>
 40    /// <param name="hasTrailer">Optional filter by items with trailers.</param>
 41    /// <param name="adjacentTo">Optional. Return items that are siblings of a supplied item.</param>
 42    /// <param name="parentIndexNumber">Optional filter by parent index number.</param>
 43    /// <param name="hasParentalRating">Optional filter by items that have or do not have a parental rating.</param>
 44    /// <param name="isHd">Optional filter by items that are HD or not.</param>
 45    /// <param name="is4K">Optional filter by items that are 4K or not.</param>
 46    /// <param name="locationTypes">Optional. If specified, results will be filtered based on LocationType. This allows 
 47    /// <param name="excludeLocationTypes">Optional. If specified, results will be filtered based on the LocationType. T
 48    /// <param name="isMissing">Optional filter by items that are missing episodes or not.</param>
 49    /// <param name="isUnaired">Optional filter by items that are unaired episodes or not.</param>
 50    /// <param name="minCommunityRating">Optional filter by minimum community rating.</param>
 51    /// <param name="minCriticRating">Optional filter by minimum critic rating.</param>
 52    /// <param name="minPremiereDate">Optional. The minimum premiere date. Format = ISO.</param>
 53    /// <param name="minDateLastSaved">Optional. The minimum last saved date. Format = ISO.</param>
 54    /// <param name="minDateLastSavedForUser">Optional. The minimum last saved date for the current user. Format = ISO.<
 55    /// <param name="maxPremiereDate">Optional. The maximum premiere date. Format = ISO.</param>
 56    /// <param name="hasOverview">Optional filter by items that have an overview or not.</param>
 57    /// <param name="hasImdbId">Optional filter by items that have an IMDb id or not.</param>
 58    /// <param name="hasTmdbId">Optional filter by items that have a TMDb id or not.</param>
 59    /// <param name="hasTvdbId">Optional filter by items that have a TVDb id or not.</param>
 60    /// <param name="isMovie">Optional filter for live tv movies.</param>
 61    /// <param name="isSeries">Optional filter for live tv series.</param>
 62    /// <param name="isNews">Optional filter for live tv news.</param>
 63    /// <param name="isKids">Optional filter for live tv kids.</param>
 64    /// <param name="isSports">Optional filter for live tv sports.</param>
 65    /// <param name="excludeItemIds">Optional. If specified, results will be filtered by excluding item ids. This allows
 66    /// <param name="startIndex">Optional. The record index to start at. All items with a lower index will be dropped fr
 67    /// <param name="limit">Optional. The maximum number of records to return.</param>
 68    /// <param name="recursive">When searching within folders, this determines whether or not the search will be recursi
 69    /// <param name="searchTerm">Optional. Filter based on a search term.</param>
 70    /// <param name="sortOrder">Sort Order - Ascending, Descending.</param>
 71    /// <param name="parentId">Specify this to localize the search to a specific item or folder. Omit to use the root.</
 72    /// <param name="fields">Optional. Specify additional fields of information to return in the output. This allows mul
 73    /// <param name="excludeItemTypes">Optional. If specified, results will be filtered based on item type. This allows 
 74    /// <param name="filters">Optional. Specify additional filters to apply. This allows multiple, comma delimited. Opti
 75    /// <param name="isFavorite">Optional filter by items that are marked as favorite, or not.</param>
 76    /// <param name="mediaTypes">Optional filter by MediaType. Allows multiple, comma delimited.</param>
 77    /// <param name="imageTypes">Optional. If specified, results will be filtered based on those containing image types.
 78    /// <param name="sortBy">Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Ar
 79    /// <param name="isPlayed">Optional filter by items that are played, or not.</param>
 80    /// <param name="genres">Optional. If specified, results will be filtered based on genre. This allows multiple, pipe
 81    /// <param name="officialRatings">Optional. If specified, results will be filtered based on OfficialRating. This all
 82    /// <param name="tags">Optional. If specified, results will be filtered based on tag. This allows multiple, pipe del
 83    /// <param name="years">Optional. If specified, results will be filtered based on production year. This allows multi
 84    /// <param name="enableUserData">Optional, include user data.</param>
 85    /// <param name="imageTypeLimit">Optional, the max number of images to return, per image type.</param>
 86    /// <param name="enableImageTypes">Optional. The image types to include in the output.</param>
 87    /// <param name="person">Optional. If specified, results will be filtered to include only those containing the speci
 88    /// <param name="personIds">Optional. If specified, results will be filtered to include only those containing the sp
 89    /// <param name="personTypes">Optional. If specified, along with Person, results will be filtered to include only th
 90    /// <param name="studios">Optional. If specified, results will be filtered based on studio. This allows multiple, pi
 91    /// <param name="artists">Optional. If specified, results will be filtered based on artists. This allows multiple, p
 92    /// <param name="excludeArtistIds">Optional. If specified, results will be filtered based on artist id. This allows 
 93    /// <param name="artistIds">Optional. If specified, results will be filtered to include only those containing the sp
 94    /// <param name="albumArtistIds">Optional. If specified, results will be filtered to include only those containing t
 95    /// <param name="contributingArtistIds">Optional. If specified, results will be filtered to include only those conta
 96    /// <param name="albums">Optional. If specified, results will be filtered based on album. This allows multiple, pipe
 97    /// <param name="albumIds">Optional. If specified, results will be filtered based on album id. This allows multiple,
 98    /// <param name="ids">Optional. If specific items are needed, specify a list of item id's to retrieve. This allows m
 99    /// <param name="videoTypes">Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma deli
 100    /// <param name="minOfficialRating">Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).</param>
 101    /// <param name="isLocked">Optional filter by items that are locked.</param>
 102    /// <param name="isPlaceHolder">Optional filter by items that are placeholders.</param>
 103    /// <param name="hasOfficialRating">Optional filter by items that have official ratings.</param>
 104    /// <param name="collapseBoxSetItems">Whether or not to hide items behind their boxsets.</param>
 105    /// <param name="minWidth">Optional. Filter by the minimum width of the item.</param>
 106    /// <param name="minHeight">Optional. Filter by the minimum height of the item.</param>
 107    /// <param name="maxWidth">Optional. Filter by the maximum width of the item.</param>
 108    /// <param name="maxHeight">Optional. Filter by the maximum height of the item.</param>
 109    /// <param name="is3D">Optional filter by items that are 3D, or not.</param>
 110    /// <param name="seriesStatus">Optional filter by Series Status. Allows multiple, comma delimited.</param>
 111    /// <param name="nameStartsWithOrGreater">Optional filter by items whose name is sorted equally or greater than a gi
 112    /// <param name="nameStartsWith">Optional filter by items whose name is sorted equally than a given input string.</p
 113    /// <param name="nameLessThan">Optional filter by items whose name is equally or lesser than a given input string.</
 114    /// <param name="studioIds">Optional. If specified, results will be filtered based on studio id. This allows multipl
 115    /// <param name="genreIds">Optional. If specified, results will be filtered based on genre id. This allows multiple,
 116    /// <param name="enableTotalRecordCount">Optional. Enable the total record count.</param>
 117    /// <param name="enableImages">Optional, include image information in output.</param>
 118    /// <returns>A <see cref="QueryResult{BaseItemDto}"/> with the trailers.</returns>
 119    [HttpGet]
 120    [ProducesResponseType(StatusCodes.Status200OK)]
 121    public ActionResult<QueryResult<BaseItemDto>> GetTrailers(
 122        [FromQuery] Guid? userId,
 123        [FromQuery] string? maxOfficialRating,
 124        [FromQuery] bool? hasThemeSong,
 125        [FromQuery] bool? hasThemeVideo,
 126        [FromQuery] bool? hasSubtitles,
 127        [FromQuery] bool? hasSpecialFeature,
 128        [FromQuery] bool? hasTrailer,
 129        [FromQuery] Guid? adjacentTo,
 130        [FromQuery] int? parentIndexNumber,
 131        [FromQuery] bool? hasParentalRating,
 132        [FromQuery] bool? isHd,
 133        [FromQuery] bool? is4K,
 134        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] locationTypes,
 135        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] LocationType[] excludeLocationTypes,
 136        [FromQuery] bool? isMissing,
 137        [FromQuery] bool? isUnaired,
 138        [FromQuery] double? minCommunityRating,
 139        [FromQuery] double? minCriticRating,
 140        [FromQuery] DateTime? minPremiereDate,
 141        [FromQuery] DateTime? minDateLastSaved,
 142        [FromQuery] DateTime? minDateLastSavedForUser,
 143        [FromQuery] DateTime? maxPremiereDate,
 144        [FromQuery] bool? hasOverview,
 145        [FromQuery] bool? hasImdbId,
 146        [FromQuery] bool? hasTmdbId,
 147        [FromQuery] bool? hasTvdbId,
 148        [FromQuery] bool? isMovie,
 149        [FromQuery] bool? isSeries,
 150        [FromQuery] bool? isNews,
 151        [FromQuery] bool? isKids,
 152        [FromQuery] bool? isSports,
 153        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeItemIds,
 154        [FromQuery] int? startIndex,
 155        [FromQuery] int? limit,
 156        [FromQuery] bool? recursive,
 157        [FromQuery] string? searchTerm,
 158        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SortOrder[] sortOrder,
 159        [FromQuery] Guid? parentId,
 160        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFields[] fields,
 161        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] BaseItemKind[] excludeItemTypes,
 162        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemFilter[] filters,
 163        [FromQuery] bool? isFavorite,
 164        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] MediaType[] mediaTypes,
 165        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] imageTypes,
 166        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ItemSortBy[] sortBy,
 167        [FromQuery] bool? isPlayed,
 168        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] genres,
 169        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] officialRatings,
 170        [FromQuery, ModelBinder(typeof(PipeDelimitedCollectionModelBinder))] string[] tags,
 171        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] int[] years,
 172        [FromQuery] bool? enableUserData,
 173        [FromQuery] int? imageTypeLimit,
 174        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] ImageType[] enableImageTypes,
 175        [FromQuery] string? person,
 176        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] personIds,
 177        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] personTypes,
 178        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] studios,
 179        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] artists,
 180        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] excludeArtistIds,
 181        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] artistIds,
 182        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumArtistIds,
 183        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] contributingArtistIds,
 184        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] string[] albums,
 185        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] albumIds,
 186        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] ids,
 187        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] VideoType[] videoTypes,
 188        [FromQuery] string? minOfficialRating,
 189        [FromQuery] bool? isLocked,
 190        [FromQuery] bool? isPlaceHolder,
 191        [FromQuery] bool? hasOfficialRating,
 192        [FromQuery] bool? collapseBoxSetItems,
 193        [FromQuery] int? minWidth,
 194        [FromQuery] int? minHeight,
 195        [FromQuery] int? maxWidth,
 196        [FromQuery] int? maxHeight,
 197        [FromQuery] bool? is3D,
 198        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] SeriesStatus[] seriesStatus,
 199        [FromQuery] string? nameStartsWithOrGreater,
 200        [FromQuery] string? nameStartsWith,
 201        [FromQuery] string? nameLessThan,
 202        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] studioIds,
 203        [FromQuery, ModelBinder(typeof(CommaDelimitedCollectionModelBinder))] Guid[] genreIds,
 204        [FromQuery] bool enableTotalRecordCount = true,
 205        [FromQuery] bool? enableImages = true)
 206    {
 0207        var includeItemTypes = new[] { BaseItemKind.Trailer };
 208
 0209        return _itemsController
 0210            .GetItems(
 0211                userId,
 0212                maxOfficialRating,
 0213                hasThemeSong,
 0214                hasThemeVideo,
 0215                hasSubtitles,
 0216                hasSpecialFeature,
 0217                hasTrailer,
 0218                adjacentTo,
 0219                null,
 0220                parentIndexNumber,
 0221                hasParentalRating,
 0222                isHd,
 0223                is4K,
 0224                locationTypes,
 0225                excludeLocationTypes,
 0226                isMissing,
 0227                isUnaired,
 0228                minCommunityRating,
 0229                minCriticRating,
 0230                minPremiereDate,
 0231                minDateLastSaved,
 0232                minDateLastSavedForUser,
 0233                maxPremiereDate,
 0234                hasOverview,
 0235                hasImdbId,
 0236                hasTmdbId,
 0237                hasTvdbId,
 0238                isMovie,
 0239                isSeries,
 0240                isNews,
 0241                isKids,
 0242                isSports,
 0243                excludeItemIds,
 0244                startIndex,
 0245                limit,
 0246                recursive,
 0247                searchTerm,
 0248                sortOrder,
 0249                parentId,
 0250                fields,
 0251                excludeItemTypes,
 0252                includeItemTypes,
 0253                filters,
 0254                isFavorite,
 0255                mediaTypes,
 0256                imageTypes,
 0257                sortBy,
 0258                isPlayed,
 0259                genres,
 0260                officialRatings,
 0261                tags,
 0262                years,
 0263                enableUserData,
 0264                imageTypeLimit,
 0265                enableImageTypes,
 0266                person,
 0267                personIds,
 0268                personTypes,
 0269                studios,
 0270                artists,
 0271                excludeArtistIds,
 0272                artistIds,
 0273                albumArtistIds,
 0274                contributingArtistIds,
 0275                albums,
 0276                albumIds,
 0277                ids,
 0278                videoTypes,
 0279                minOfficialRating,
 0280                isLocked,
 0281                isPlaceHolder,
 0282                hasOfficialRating,
 0283                collapseBoxSetItems,
 0284                minWidth,
 0285                minHeight,
 0286                maxWidth,
 0287                maxHeight,
 0288                is3D,
 0289                seriesStatus,
 0290                nameStartsWithOrGreater,
 0291                nameStartsWith,
 0292                nameLessThan,
 0293                studioIds,
 0294                genreIds,
 0295                enableTotalRecordCount,
 0296                enableImages);
 297    }
 298}
Generated by: ReportGenerator 5.4.5.0
4/26/2025 - 12:10:58 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(Jellyfin.Api.Controllers.ItemsController)
GetTrailers(System.Nullable`1<System.Guid>,System.String,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Guid>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,MediaBrowser.Model.Entities.LocationType[],MediaBrowser.Model.Entities.LocationType[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Double>,System.Nullable`1<System.Double>,System.Nullable`1<System.DateTime>,System.Nullable`1<System.DateTime>,System.Nullable`1<System.DateTime>,System.Nullable`1<System.DateTime>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Guid[],System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Boolean>,System.String,Jellyfin.Database.Implementations.Enums.SortOrder[],System.Nullable`1<System.Guid>,MediaBrowser.Model.Querying.ItemFields[],Jellyfin.Data.Enums.BaseItemKind[],MediaBrowser.Model.Querying.ItemFilter[],System.Nullable`1<System.Boolean>,Jellyfin.Data.Enums.MediaType[],MediaBrowser.Model.Entities.ImageType[],Jellyfin.Data.Enums.ItemSortBy[],System.Nullable`1<System.Boolean>,System.String[],System.String[],System.String[],System.Int32[],System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,MediaBrowser.Model.Entities.ImageType[],System.String,System.Guid[],System.String[],System.String[],System.String[],System.Guid[],System.Guid[],System.Guid[],System.Guid[],System.String[],System.Guid[],System.Guid[],MediaBrowser.Model.Entities.VideoType[],System.String,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Boolean>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Int32>,System.Nullable`1<System.Boolean>,MediaBrowser.Model.Entities.SeriesStatus[],System.String,System.String,System.String,System.Guid[],System.Guid[],System.Boolean,System.Nullable`1<System.Boolean>)