PlaystateController.cs 24 KB

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