< Summary - Jellyfin

Information
Class: Jellyfin.Api.Controllers.PlaystateController
Assembly: Jellyfin.Api
File(s): /srv/git/jellyfin/Jellyfin.Api/Controllers/PlaystateController.cs
Line coverage
40%
Covered lines: 30
Uncovered lines: 44
Coverable lines: 74
Total lines: 538
Line coverage: 40.5%
Branch coverage
21%
Covered branches: 6
Total branches: 28
Branch coverage: 21.4%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Coverage history

Coverage history 0 25 50 75 100 1/23/2026 - 12:11:06 AM Line coverage: 56% (14/25) Branch coverage: 0% (0/8) Total lines: 5354/19/2026 - 12:14:27 AM Line coverage: 40.5% (30/74) Branch coverage: 21.4% (6/28) Total lines: 5354/30/2026 - 12:14:58 AM Line coverage: 40.5% (30/74) Branch coverage: 21.4% (6/28) Total lines: 538 1/23/2026 - 12:11:06 AM Line coverage: 56% (14/25) Branch coverage: 0% (0/8) Total lines: 5354/19/2026 - 12:14:27 AM Line coverage: 40.5% (30/74) Branch coverage: 21.4% (6/28) Total lines: 5354/30/2026 - 12:14:58 AM Line coverage: 40.5% (30/74) Branch coverage: 21.4% (6/28) Total lines: 538

Coverage delta

Coverage delta 22 -22

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
MarkPlayedItem()37.5%16850%
MarkUnplayedItem()37.5%16850%
ReportPlaybackStart()100%210%
ReportPlaybackProgress()100%210%
PingPlaybackSession(...)100%210%
ReportPlaybackStopped()0%2040%
UpdatePlayedStatus(...)0%620%
ValidatePlayMethod(...)0%4260%

File(s)

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

#LineLine coverage
 1using System;
 2using System.ComponentModel.DataAnnotations;
 3using System.Diagnostics.CodeAnalysis;
 4using System.Threading.Tasks;
 5using Jellyfin.Api.Extensions;
 6using Jellyfin.Api.Helpers;
 7using Jellyfin.Api.ModelBinders;
 8using Jellyfin.Database.Implementations.Entities;
 9using MediaBrowser.Controller.Entities;
 10using MediaBrowser.Controller.Library;
 11using MediaBrowser.Controller.MediaEncoding;
 12using MediaBrowser.Controller.Session;
 13using MediaBrowser.Model.Dto;
 14using MediaBrowser.Model.Session;
 15using Microsoft.AspNetCore.Authorization;
 16using Microsoft.AspNetCore.Http;
 17using Microsoft.AspNetCore.Mvc;
 18using Microsoft.Extensions.Logging;
 19
 20namespace Jellyfin.Api.Controllers;
 21
 22/// <summary>
 23/// Playstate controller.
 24/// </summary>
 25[Route("")]
 26[Authorize]
 27[Tags("Session")]
 28public class PlaystateController : BaseJellyfinApiController
 29{
 30    private readonly IUserManager _userManager;
 31    private readonly IUserDataManager _userDataRepository;
 32    private readonly ILibraryManager _libraryManager;
 33    private readonly ISessionManager _sessionManager;
 34    private readonly ILogger<PlaystateController> _logger;
 35    private readonly ITranscodeManager _transcodeManager;
 36
 37    /// <summary>
 38    /// Initializes a new instance of the <see cref="PlaystateController"/> class.
 39    /// </summary>
 40    /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param>
 41    /// <param name="userDataRepository">Instance of the <see cref="IUserDataManager"/> interface.</param>
 42    /// <param name="libraryManager">Instance of the <see cref="ILibraryManager"/> interface.</param>
 43    /// <param name="sessionManager">Instance of the <see cref="ISessionManager"/> interface.</param>
 44    /// <param name="loggerFactory">Instance of the <see cref="ILoggerFactory"/> interface.</param>
 45    /// <param name="transcodeManager">Instance of the <see cref="ITranscodeManager"/> interface.</param>
 446    public PlaystateController(
 447        IUserManager userManager,
 448        IUserDataManager userDataRepository,
 449        ILibraryManager libraryManager,
 450        ISessionManager sessionManager,
 451        ILoggerFactory loggerFactory,
 452        ITranscodeManager transcodeManager)
 53    {
 454        _userManager = userManager;
 455        _userDataRepository = userDataRepository;
 456        _libraryManager = libraryManager;
 457        _sessionManager = sessionManager;
 458        _logger = loggerFactory.CreateLogger<PlaystateController>();
 59
 460        _transcodeManager = transcodeManager;
 461    }
 62
 63    /// <summary>
 64    /// Marks an item as played for user.
 65    /// </summary>
 66    /// <param name="userId">User id.</param>
 67    /// <param name="itemId">Item id.</param>
 68    /// <param name="datePlayed">Optional. The date the item was played.</param>
 69    /// <response code="200">Item marked as played.</response>
 70    /// <response code="404">Item not found.</response>
 71    /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>, or a <see cref="NotFoundResult"
 72    [HttpPost("UserPlayedItems/{itemId}")]
 73    [ProducesResponseType(StatusCodes.Status200OK)]
 74    [ProducesResponseType(StatusCodes.Status404NotFound)]
 75    public async Task<ActionResult<UserItemDataDto?>> MarkPlayedItem(
 76        [FromQuery] Guid? userId,
 77        [FromRoute, Required] Guid itemId,
 78        [FromQuery, ModelBinder(typeof(LegacyDateTimeModelBinder))] DateTime? datePlayed)
 79    {
 280        userId = RequestHelpers.GetUserId(User, userId);
 281        var user = _userManager.GetUserById(userId.Value);
 282        if (user is null)
 83        {
 184            return NotFound();
 85        }
 86
 187        var item = _libraryManager.GetItemById<BaseItem>(itemId, user);
 188        if (item is null)
 89        {
 190            return NotFound();
 91        }
 92
 093        var session = await RequestHelpers.GetSession(_sessionManager, _userManager, HttpContext, userId).ConfigureAwait
 94
 095        var dto = UpdatePlayedStatus(user, item, true, datePlayed);
 096        foreach (var additionalUserInfo in session.AdditionalUsers)
 97        {
 098            var additionalUser = _userManager.GetUserById(additionalUserInfo.UserId);
 099            if (additionalUser is null)
 100            {
 0101                return NotFound();
 102            }
 103
 0104            UpdatePlayedStatus(additionalUser, item, true, datePlayed);
 105        }
 106
 0107        return dto;
 2108    }
 109
 110    /// <summary>
 111    /// Marks an item as played for user.
 112    /// </summary>
 113    /// <param name="userId">User id.</param>
 114    /// <param name="itemId">Item id.</param>
 115    /// <param name="datePlayed">Optional. The date the item was played.</param>
 116    /// <response code="200">Item marked as played.</response>
 117    /// <response code="404">Item not found.</response>
 118    /// <returns>An <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>, or a <see cref="NotFoundResult"
 119    [HttpPost("Users/{userId}/PlayedItems/{itemId}")]
 120    [ProducesResponseType(StatusCodes.Status200OK)]
 121    [ProducesResponseType(StatusCodes.Status404NotFound)]
 122    [Obsolete("Kept for backwards compatibility")]
 123    [ApiExplorerSettings(IgnoreApi = true)]
 124    public Task<ActionResult<UserItemDataDto?>> MarkPlayedItemLegacy(
 125        [FromRoute, Required] Guid userId,
 126        [FromRoute, Required] Guid itemId,
 127        [FromQuery, ModelBinder(typeof(LegacyDateTimeModelBinder))] DateTime? datePlayed)
 128        => MarkPlayedItem(userId, itemId, datePlayed);
 129
 130    /// <summary>
 131    /// Marks an item as unplayed for user.
 132    /// </summary>
 133    /// <param name="userId">User id.</param>
 134    /// <param name="itemId">Item id.</param>
 135    /// <response code="200">Item marked as unplayed.</response>
 136    /// <response code="404">Item not found.</response>
 137    /// <returns>A <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>, or a <see cref="NotFoundResult"/
 138    [HttpDelete("UserPlayedItems/{itemId}")]
 139    [ProducesResponseType(StatusCodes.Status200OK)]
 140    [ProducesResponseType(StatusCodes.Status404NotFound)]
 141    public async Task<ActionResult<UserItemDataDto?>> MarkUnplayedItem(
 142        [FromQuery] Guid? userId,
 143        [FromRoute, Required] Guid itemId)
 144    {
 2145        userId = RequestHelpers.GetUserId(User, userId);
 2146        var user = _userManager.GetUserById(userId.Value);
 2147        if (user is null)
 148        {
 1149            return NotFound();
 150        }
 151
 1152        var item = _libraryManager.GetItemById<BaseItem>(itemId, user);
 1153        if (item is null)
 154        {
 1155            return NotFound();
 156        }
 157
 0158        var session = await RequestHelpers.GetSession(_sessionManager, _userManager, HttpContext, userId).ConfigureAwait
 159
 0160        var dto = UpdatePlayedStatus(user, item, false, null);
 0161        foreach (var additionalUserInfo in session.AdditionalUsers)
 162        {
 0163            var additionalUser = _userManager.GetUserById(additionalUserInfo.UserId);
 0164            if (additionalUser is null)
 165            {
 0166                return NotFound();
 167            }
 168
 0169            UpdatePlayedStatus(additionalUser, item, false, null);
 170        }
 171
 0172        return dto;
 2173    }
 174
 175    /// <summary>
 176    /// Marks an item as unplayed for user.
 177    /// </summary>
 178    /// <param name="userId">User id.</param>
 179    /// <param name="itemId">Item id.</param>
 180    /// <response code="200">Item marked as unplayed.</response>
 181    /// <response code="404">Item not found.</response>
 182    /// <returns>A <see cref="OkResult"/> containing the <see cref="UserItemDataDto"/>, or a <see cref="NotFoundResult"/
 183    [HttpDelete("Users/{userId}/PlayedItems/{itemId}")]
 184    [ProducesResponseType(StatusCodes.Status200OK)]
 185    [ProducesResponseType(StatusCodes.Status404NotFound)]
 186    [Obsolete("Kept for backwards compatibility")]
 187    [ApiExplorerSettings(IgnoreApi = true)]
 188    public Task<ActionResult<UserItemDataDto?>> MarkUnplayedItemLegacy(
 189        [FromRoute, Required] Guid userId,
 190        [FromRoute, Required] Guid itemId)
 191        => MarkUnplayedItem(userId, itemId);
 192
 193    /// <summary>
 194    /// Reports playback has started within a session.
 195    /// </summary>
 196    /// <param name="playbackStartInfo">The playback start info.</param>
 197    /// <response code="204">Playback start recorded.</response>
 198    /// <returns>A <see cref="NoContentResult"/>.</returns>
 199    [HttpPost("Sessions/Playing")]
 200    [ProducesResponseType(StatusCodes.Status204NoContent)]
 201    public async Task<ActionResult> ReportPlaybackStart([FromBody] PlaybackStartInfo playbackStartInfo)
 202    {
 0203        playbackStartInfo.PlayMethod = ValidatePlayMethod(playbackStartInfo.PlayMethod, playbackStartInfo.PlaySessionId)
 0204        playbackStartInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).Conf
 0205        await _sessionManager.OnPlaybackStart(playbackStartInfo).ConfigureAwait(false);
 0206        return NoContent();
 0207    }
 208
 209    /// <summary>
 210    /// Reports playback progress within a session.
 211    /// </summary>
 212    /// <param name="playbackProgressInfo">The playback progress info.</param>
 213    /// <response code="204">Playback progress recorded.</response>
 214    /// <returns>A <see cref="NoContentResult"/>.</returns>
 215    [HttpPost("Sessions/Playing/Progress")]
 216    [ProducesResponseType(StatusCodes.Status204NoContent)]
 217    public async Task<ActionResult> ReportPlaybackProgress([FromBody] PlaybackProgressInfo playbackProgressInfo)
 218    {
 0219        playbackProgressInfo.PlayMethod = ValidatePlayMethod(playbackProgressInfo.PlayMethod, playbackProgressInfo.PlayS
 0220        playbackProgressInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).C
 0221        await _sessionManager.OnPlaybackProgress(playbackProgressInfo).ConfigureAwait(false);
 0222        return NoContent();
 0223    }
 224
 225    /// <summary>
 226    /// Pings a playback session.
 227    /// </summary>
 228    /// <param name="playSessionId">Playback session id.</param>
 229    /// <response code="204">Playback session pinged.</response>
 230    /// <returns>A <see cref="NoContentResult"/>.</returns>
 231    [HttpPost("Sessions/Playing/Ping")]
 232    [ProducesResponseType(StatusCodes.Status204NoContent)]
 233    public ActionResult PingPlaybackSession([FromQuery, Required] string playSessionId)
 234    {
 0235        _transcodeManager.PingTranscodingJob(playSessionId, null);
 0236        return NoContent();
 237    }
 238
 239    /// <summary>
 240    /// Reports playback has stopped within a session.
 241    /// </summary>
 242    /// <param name="playbackStopInfo">The playback stop info.</param>
 243    /// <response code="204">Playback stop recorded.</response>
 244    /// <returns>A <see cref="NoContentResult"/>.</returns>
 245    [HttpPost("Sessions/Playing/Stopped")]
 246    [ProducesResponseType(StatusCodes.Status204NoContent)]
 247    public async Task<ActionResult> ReportPlaybackStopped([FromBody] PlaybackStopInfo playbackStopInfo)
 248    {
 0249        _logger.LogDebug("ReportPlaybackStopped PlaySessionId: {0}", playbackStopInfo.PlaySessionId ?? string.Empty);
 0250        if (!string.IsNullOrWhiteSpace(playbackStopInfo.PlaySessionId))
 251        {
 0252            await _transcodeManager.KillTranscodingJobs(User.GetDeviceId()!, playbackStopInfo.PlaySessionId, s => true).
 253        }
 254
 0255        playbackStopInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).Confi
 0256        await _sessionManager.OnPlaybackStopped(playbackStopInfo).ConfigureAwait(false);
 0257        return NoContent();
 0258    }
 259
 260    /// <summary>
 261    /// Reports that a session has begun playing an item.
 262    /// </summary>
 263    /// <param name="itemId">Item id.</param>
 264    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 265    /// <param name="audioStreamIndex">The audio stream index.</param>
 266    /// <param name="subtitleStreamIndex">The subtitle stream index.</param>
 267    /// <param name="playMethod">The play method.</param>
 268    /// <param name="liveStreamId">The live stream id.</param>
 269    /// <param name="playSessionId">The play session id.</param>
 270    /// <param name="canSeek">Indicates if the client can seek.</param>
 271    /// <response code="204">Play start recorded.</response>
 272    /// <returns>A <see cref="NoContentResult"/>.</returns>
 273    [HttpPost("PlayingItems/{itemId}")]
 274    [ProducesResponseType(StatusCodes.Status204NoContent)]
 275    [Obsolete("This endpoint is obsolete. Use ReportPlaybackStart instead")]
 276    [ApiExplorerSettings(IgnoreApi = true)]
 277    public async Task<ActionResult> OnPlaybackStart(
 278        [FromRoute, Required] Guid itemId,
 279        [FromQuery] string? mediaSourceId,
 280        [FromQuery] int? audioStreamIndex,
 281        [FromQuery] int? subtitleStreamIndex,
 282        [FromQuery] PlayMethod? playMethod,
 283        [FromQuery] string? liveStreamId,
 284        [FromQuery] string? playSessionId,
 285        [FromQuery] bool canSeek = false)
 286    {
 287        var playbackStartInfo = new PlaybackStartInfo
 288        {
 289            CanSeek = canSeek,
 290            ItemId = itemId,
 291            MediaSourceId = mediaSourceId,
 292            AudioStreamIndex = audioStreamIndex,
 293            SubtitleStreamIndex = subtitleStreamIndex,
 294            PlayMethod = playMethod ?? PlayMethod.Transcode,
 295            PlaySessionId = playSessionId,
 296            LiveStreamId = liveStreamId
 297        };
 298
 299        playbackStartInfo.PlayMethod = ValidatePlayMethod(playbackStartInfo.PlayMethod, playbackStartInfo.PlaySessionId)
 300        playbackStartInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).Conf
 301        await _sessionManager.OnPlaybackStart(playbackStartInfo).ConfigureAwait(false);
 302        return NoContent();
 303    }
 304
 305    /// <summary>
 306    /// Reports that a user has begun playing an item.
 307    /// </summary>
 308    /// <param name="userId">User id.</param>
 309    /// <param name="itemId">Item id.</param>
 310    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 311    /// <param name="audioStreamIndex">The audio stream index.</param>
 312    /// <param name="subtitleStreamIndex">The subtitle stream index.</param>
 313    /// <param name="playMethod">The play method.</param>
 314    /// <param name="liveStreamId">The live stream id.</param>
 315    /// <param name="playSessionId">The play session id.</param>
 316    /// <param name="canSeek">Indicates if the client can seek.</param>
 317    /// <response code="204">Play start recorded.</response>
 318    /// <returns>A <see cref="NoContentResult"/>.</returns>
 319    [HttpPost("Users/{userId}/PlayingItems/{itemId}")]
 320    [ProducesResponseType(StatusCodes.Status204NoContent)]
 321    [Obsolete("Kept for backwards compatibility")]
 322    [ApiExplorerSettings(IgnoreApi = true)]
 323    [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "userId", Justification = "Re
 324    public Task<ActionResult> OnPlaybackStartLegacy(
 325        [FromRoute, Required] Guid userId,
 326        [FromRoute, Required] Guid itemId,
 327        [FromQuery] string? mediaSourceId,
 328        [FromQuery] int? audioStreamIndex,
 329        [FromQuery] int? subtitleStreamIndex,
 330        [FromQuery] PlayMethod? playMethod,
 331        [FromQuery] string? liveStreamId,
 332        [FromQuery] string? playSessionId,
 333        [FromQuery] bool canSeek = false)
 334        => OnPlaybackStart(itemId, mediaSourceId, audioStreamIndex, subtitleStreamIndex, playMethod, liveStreamId, playS
 335
 336    /// <summary>
 337    /// Reports a session's playback progress.
 338    /// </summary>
 339    /// <param name="itemId">Item id.</param>
 340    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 341    /// <param name="positionTicks">Optional. The current position, in ticks. 1 tick = 10000 ms.</param>
 342    /// <param name="audioStreamIndex">The audio stream index.</param>
 343    /// <param name="subtitleStreamIndex">The subtitle stream index.</param>
 344    /// <param name="volumeLevel">Scale of 0-100.</param>
 345    /// <param name="playMethod">The play method.</param>
 346    /// <param name="liveStreamId">The live stream id.</param>
 347    /// <param name="playSessionId">The play session id.</param>
 348    /// <param name="repeatMode">The repeat mode.</param>
 349    /// <param name="isPaused">Indicates if the player is paused.</param>
 350    /// <param name="isMuted">Indicates if the player is muted.</param>
 351    /// <response code="204">Play progress recorded.</response>
 352    /// <returns>A <see cref="NoContentResult"/>.</returns>
 353    [HttpPost("PlayingItems/{itemId}/Progress")]
 354    [ProducesResponseType(StatusCodes.Status204NoContent)]
 355    [Obsolete("This endpoint is obsolete. Use ReportPlaybackProgress instead")]
 356    [ApiExplorerSettings(IgnoreApi = true)]
 357    public async Task<ActionResult> OnPlaybackProgress(
 358        [FromRoute, Required] Guid itemId,
 359        [FromQuery] string? mediaSourceId,
 360        [FromQuery] long? positionTicks,
 361        [FromQuery] int? audioStreamIndex,
 362        [FromQuery] int? subtitleStreamIndex,
 363        [FromQuery] int? volumeLevel,
 364        [FromQuery] PlayMethod? playMethod,
 365        [FromQuery] string? liveStreamId,
 366        [FromQuery] string? playSessionId,
 367        [FromQuery] RepeatMode? repeatMode,
 368        [FromQuery] bool isPaused = false,
 369        [FromQuery] bool isMuted = false)
 370    {
 371        var playbackProgressInfo = new PlaybackProgressInfo
 372        {
 373            ItemId = itemId,
 374            PositionTicks = positionTicks,
 375            IsMuted = isMuted,
 376            IsPaused = isPaused,
 377            MediaSourceId = mediaSourceId,
 378            AudioStreamIndex = audioStreamIndex,
 379            SubtitleStreamIndex = subtitleStreamIndex,
 380            VolumeLevel = volumeLevel,
 381            PlayMethod = playMethod ?? PlayMethod.Transcode,
 382            PlaySessionId = playSessionId,
 383            LiveStreamId = liveStreamId,
 384            RepeatMode = repeatMode ?? RepeatMode.RepeatNone
 385        };
 386
 387        playbackProgressInfo.PlayMethod = ValidatePlayMethod(playbackProgressInfo.PlayMethod, playbackProgressInfo.PlayS
 388        playbackProgressInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).C
 389        await _sessionManager.OnPlaybackProgress(playbackProgressInfo).ConfigureAwait(false);
 390        return NoContent();
 391    }
 392
 393    /// <summary>
 394    /// Reports a user's playback progress.
 395    /// </summary>
 396    /// <param name="userId">User id.</param>
 397    /// <param name="itemId">Item id.</param>
 398    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 399    /// <param name="positionTicks">Optional. The current position, in ticks. 1 tick = 10000 ms.</param>
 400    /// <param name="audioStreamIndex">The audio stream index.</param>
 401    /// <param name="subtitleStreamIndex">The subtitle stream index.</param>
 402    /// <param name="volumeLevel">Scale of 0-100.</param>
 403    /// <param name="playMethod">The play method.</param>
 404    /// <param name="liveStreamId">The live stream id.</param>
 405    /// <param name="playSessionId">The play session id.</param>
 406    /// <param name="repeatMode">The repeat mode.</param>
 407    /// <param name="isPaused">Indicates if the player is paused.</param>
 408    /// <param name="isMuted">Indicates if the player is muted.</param>
 409    /// <response code="204">Play progress recorded.</response>
 410    /// <returns>A <see cref="NoContentResult"/>.</returns>
 411    [HttpPost("Users/{userId}/PlayingItems/{itemId}/Progress")]
 412    [ProducesResponseType(StatusCodes.Status204NoContent)]
 413    [Obsolete("Kept for backwards compatibility")]
 414    [ApiExplorerSettings(IgnoreApi = true)]
 415    [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "userId", Justification = "Re
 416    public Task<ActionResult> OnPlaybackProgressLegacy(
 417        [FromRoute, Required] Guid userId,
 418        [FromRoute, Required] Guid itemId,
 419        [FromQuery] string? mediaSourceId,
 420        [FromQuery] long? positionTicks,
 421        [FromQuery] int? audioStreamIndex,
 422        [FromQuery] int? subtitleStreamIndex,
 423        [FromQuery] int? volumeLevel,
 424        [FromQuery] PlayMethod? playMethod,
 425        [FromQuery] string? liveStreamId,
 426        [FromQuery] string? playSessionId,
 427        [FromQuery] RepeatMode? repeatMode,
 428        [FromQuery] bool isPaused = false,
 429        [FromQuery] bool isMuted = false)
 430        => OnPlaybackProgress(itemId, mediaSourceId, positionTicks, audioStreamIndex, subtitleStreamIndex, volumeLevel, 
 431
 432    /// <summary>
 433    /// Reports that a session has stopped playing an item.
 434    /// </summary>
 435    /// <param name="itemId">Item id.</param>
 436    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 437    /// <param name="nextMediaType">The next media type that will play.</param>
 438    /// <param name="positionTicks">Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.</param>
 439    /// <param name="liveStreamId">The live stream id.</param>
 440    /// <param name="playSessionId">The play session id.</param>
 441    /// <response code="204">Playback stop recorded.</response>
 442    /// <returns>A <see cref="NoContentResult"/>.</returns>
 443    [HttpDelete("PlayingItems/{itemId}")]
 444    [ProducesResponseType(StatusCodes.Status204NoContent)]
 445    [Obsolete("This endpoint is obsolete. Use ReportPlaybackStop instead")]
 446    [ApiExplorerSettings(IgnoreApi = true)]
 447    public async Task<ActionResult> OnPlaybackStopped(
 448        [FromRoute, Required] Guid itemId,
 449        [FromQuery] string? mediaSourceId,
 450        [FromQuery] string? nextMediaType,
 451        [FromQuery] long? positionTicks,
 452        [FromQuery] string? liveStreamId,
 453        [FromQuery] string? playSessionId)
 454    {
 455        var playbackStopInfo = new PlaybackStopInfo
 456        {
 457            ItemId = itemId,
 458            PositionTicks = positionTicks,
 459            MediaSourceId = mediaSourceId,
 460            PlaySessionId = playSessionId,
 461            LiveStreamId = liveStreamId,
 462            NextMediaType = nextMediaType
 463        };
 464
 465        _logger.LogDebug("ReportPlaybackStopped PlaySessionId: {0}", playbackStopInfo.PlaySessionId ?? string.Empty);
 466        if (!string.IsNullOrWhiteSpace(playbackStopInfo.PlaySessionId))
 467        {
 468            await _transcodeManager.KillTranscodingJobs(User.GetDeviceId()!, playbackStopInfo.PlaySessionId, s => true).
 469        }
 470
 471        playbackStopInfo.SessionId = await RequestHelpers.GetSessionId(_sessionManager, _userManager, HttpContext).Confi
 472        await _sessionManager.OnPlaybackStopped(playbackStopInfo).ConfigureAwait(false);
 473        return NoContent();
 474    }
 475
 476    /// <summary>
 477    /// Reports that a user has stopped playing an item.
 478    /// </summary>
 479    /// <param name="userId">User id.</param>
 480    /// <param name="itemId">Item id.</param>
 481    /// <param name="mediaSourceId">The id of the MediaSource.</param>
 482    /// <param name="nextMediaType">The next media type that will play.</param>
 483    /// <param name="positionTicks">Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.</param>
 484    /// <param name="liveStreamId">The live stream id.</param>
 485    /// <param name="playSessionId">The play session id.</param>
 486    /// <response code="204">Playback stop recorded.</response>
 487    /// <returns>A <see cref="NoContentResult"/>.</returns>
 488    [HttpDelete("Users/{userId}/PlayingItems/{itemId}")]
 489    [ProducesResponseType(StatusCodes.Status204NoContent)]
 490    [Obsolete("Kept for backwards compatibility")]
 491    [ApiExplorerSettings(IgnoreApi = true)]
 492    [SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "userId", Justification = "Re
 493    public Task<ActionResult> OnPlaybackStoppedLegacy(
 494        [FromRoute, Required] Guid userId,
 495        [FromRoute, Required] Guid itemId,
 496        [FromQuery] string? mediaSourceId,
 497        [FromQuery] string? nextMediaType,
 498        [FromQuery] long? positionTicks,
 499        [FromQuery] string? liveStreamId,
 500        [FromQuery] string? playSessionId)
 501        => OnPlaybackStopped(itemId, mediaSourceId, nextMediaType, positionTicks, liveStreamId, playSessionId);
 502
 503    /// <summary>
 504    /// Updates the played status.
 505    /// </summary>
 506    /// <param name="user">The user.</param>
 507    /// <param name="item">The item.</param>
 508    /// <param name="wasPlayed">if set to <c>true</c> [was played].</param>
 509    /// <param name="datePlayed">The date played.</param>
 510    /// <returns>Task.</returns>
 511    private UserItemDataDto? UpdatePlayedStatus(User user, BaseItem item, bool wasPlayed, DateTime? datePlayed)
 512    {
 0513        if (wasPlayed)
 514        {
 0515            item.MarkPlayed(user, datePlayed, true);
 516        }
 517        else
 518        {
 0519            item.MarkUnplayed(user);
 520        }
 521
 0522        return _userDataRepository.GetUserDataDto(item, user);
 523    }
 524
 525    private PlayMethod ValidatePlayMethod(PlayMethod method, string? playSessionId)
 526    {
 0527        if (method == PlayMethod.Transcode)
 528        {
 0529            var job = string.IsNullOrWhiteSpace(playSessionId) ? null : _transcodeManager.GetTranscodingJob(playSessionI
 0530            if (job is null)
 531            {
 0532                return PlayMethod.DirectPlay;
 533            }
 534        }
 535
 0536        return method;
 537    }
 538}
Generated by: ReportGenerator 5.5.7.0
5/6/2026 - 12:15:24 AM
GitHub | reportgenerator.io

Methods/Properties

.ctor(MediaBrowser.Controller.Library.IUserManager,MediaBrowser.Controller.Library.IUserDataManager,MediaBrowser.Controller.Library.ILibraryManager,MediaBrowser.Controller.Session.ISessionManager,Microsoft.Extensions.Logging.ILoggerFactory,MediaBrowser.Controller.MediaEncoding.ITranscodeManager)
MarkPlayedItem()
MarkUnplayedItem()
ReportPlaybackStart()
ReportPlaybackProgress()
PingPlaybackSession(System.String)
ReportPlaybackStopped()
UpdatePlayedStatus(Jellyfin.Database.Implementations.Entities.User,MediaBrowser.Controller.Entities.BaseItem,System.Boolean,System.Nullable`1<System.DateTime>)
ValidatePlayMethod(MediaBrowser.Model.Session.PlayMethod,System.String)