< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.TrickplayController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/TrickplayController.cs
Line coverage
0%
Covered lines: 0
Uncovered lines: 6
Coverable lines: 6
Total lines: 105
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%

File(s)

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

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Net.Mime;
 4using System.Text;
 5using System.Threading.Tasks;
 6using Jellyfin.Api.Attributes;
 7using Jellyfin.Api.Extensions;
 8using Jellyfin.Api.Helpers;
 9using MediaBrowser.Controller.Entities;
 10using MediaBrowser.Controller.Library;
 11using MediaBrowser.Controller.Trickplay;
 12using MediaBrowser.Model;
 13using Microsoft.AspNetCore.Authorization;
 14using Microsoft.AspNetCore.Http;
 15using Microsoft.AspNetCore.Mvc;
 16
 17namespace Jellyfin.Api.Controllers;
 18
 19/// <summary>
 20/// Trickplay controller.
 21/// </summary>
 22[Route("")]
 23[Authorize]
 24public class TrickplayController : BaseJellyfinApiController
 25{
 26    private readonly ILibraryManager _libraryManager;
 27    private readonly ITrickplayManager _trickplayManager;
 28
 29    /// <summary>
 30    /// Initializes a new instance of the <see cref="TrickplayController"/> class.
 31    /// </summary>
 32    /// <param name="libraryManager">Instance of <see cref="ILibraryManager"/>.</param>
 33    /// <param name="trickplayManager">Instance of <see cref="ITrickplayManager"/>.</param>
 034    public TrickplayController(
 035        ILibraryManager libraryManager,
 036        ITrickplayManager trickplayManager)
 37    {
 038        _libraryManager = libraryManager;
 039        _trickplayManager = trickplayManager;
 040    }
 41
 42    /// <summary>
 43    /// Gets an image tiles playlist for trickplay.
 44    /// </summary>
 45    /// <param name="itemId">The item id.</param>
 46    /// <param name="width">The width of a single tile.</param>
 47    /// <param name="mediaSourceId">The media version id, if using an alternate version.</param>
 48    /// <response code="200">Tiles playlist returned.</response>
 49    /// <returns>A <see cref="FileResult"/> containing the trickplay playlist file.</returns>
 50    [HttpGet("Videos/{itemId}/Trickplay/{width}/tiles.m3u8")]
 51    [ProducesResponseType(StatusCodes.Status200OK)]
 52    [ProducesResponseType(StatusCodes.Status404NotFound)]
 53    [ProducesPlaylistFile]
 54    public async Task<ActionResult> GetTrickplayHlsPlaylist(
 55        [FromRoute, Required] Guid itemId,
 56        [FromRoute, Required] int width,
 57        [FromQuery] Guid? mediaSourceId)
 58    {
 59        string? playlist = await _trickplayManager.GetHlsPlaylist(mediaSourceId ?? itemId, width, User.GetToken()).Confi
 60
 61        if (string.IsNullOrEmpty(playlist))
 62        {
 63            return NotFound();
 64        }
 65
 66        return Content(playlist, MimeTypes.GetMimeType("playlist.m3u8"), Encoding.UTF8);
 67    }
 68
 69    /// <summary>
 70    /// Gets a trickplay tile image.
 71    /// </summary>
 72    /// <param name="itemId">The item id.</param>
 73    /// <param name="width">The width of a single tile.</param>
 74    /// <param name="index">The index of the desired tile.</param>
 75    /// <param name="mediaSourceId">The media version id, if using an alternate version.</param>
 76    /// <response code="200">Tile image returned.</response>
 77    /// <response code="200">Tile image not found at specified index.</response>
 78    /// <returns>A <see cref="FileResult"/> containing the trickplay tiles image.</returns>
 79    [HttpGet("Videos/{itemId}/Trickplay/{width}/{index}.jpg")]
 80    [ProducesResponseType(StatusCodes.Status200OK)]
 81    [ProducesResponseType(StatusCodes.Status404NotFound)]
 82    [ProducesImageFile]
 83    public async Task<ActionResult> GetTrickplayTileImageAsync(
 84        [FromRoute, Required] Guid itemId,
 85        [FromRoute, Required] int width,
 86        [FromRoute, Required] int index,
 87        [FromQuery] Guid? mediaSourceId)
 88    {
 89        var item = _libraryManager.GetItemById<BaseItem>(itemId, User.GetUserId());
 90        if (item is null)
 91        {
 92            return NotFound();
 93        }
 94
 95        var saveWithMedia = _libraryManager.GetLibraryOptions(item).SaveTrickplayWithMedia;
 96        var path = await _trickplayManager.GetTrickplayTilePathAsync(item, width, index, saveWithMedia).ConfigureAwait(f
 97        if (!string.IsNullOrEmpty(path) && System.IO.File.Exists(path))
 98        {
 99            Response.Headers.ContentDisposition = "attachment";
 100            return PhysicalFile(path, MediaTypeNames.Image.Jpeg);
 101        }
 102
 103        return NotFound();
 104    }
 105}