majomi/intro-skipper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Support returning credit timestamps

Browse Source
This commit is contained in:
ConfusedPolarBear 2022-11-25 00:40:02 -06:00
parent 7439720b3a
commit ae16603aee
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
ConfusedPolarBear.Plugin.IntroSkipper/Controllers/SkipIntroController.cs
View File

@ -26,14 +26,17 @@ public class SkipIntroController : ControllerBase
/// Returns the timestamps of the introduction in a television episode. Responses are in API version 1 format. /// Returns the timestamps of the introduction in a television episode. Responses are in API version 1 format.
/// </summary> /// </summary>
/// <param name="id">ID of the episode. Required.</param> /// <param name="id">ID of the episode. Required.</param>
/// <param name="mode">Timestamps to return. Optional. Defaults to Introduction for backwards compatibility.</param>
/// <response code="200">Episode contains an intro.</response> /// <response code="200">Episode contains an intro.</response>
/// <response code="404">Failed to find an intro in the provided episode.</response> /// <response code="404">Failed to find an intro in the provided episode.</response>
/// <returns>Detected intro.</returns> /// <returns>Detected intro.</returns>
[HttpGet("Episode/{id}/IntroTimestamps")] [HttpGet("Episode/{id}/IntroTimestamps")]
[HttpGet("Episode/{id}/IntroTimestamps/v1")] [HttpGet("Episode/{id}/IntroTimestamps/v1")]
public ActionResult<Intro> GetIntroTimestamps([FromRoute] Guid id) public ActionResult<Intro> GetIntroTimestamps(
[FromRoute] Guid id,
[FromQuery] AnalysisMode mode = AnalysisMode.Introduction)
{ {
var intro = GetIntro(id); var intro = GetIntro(id, mode);
if (intro is null || !intro.Valid) if (intro is null || !intro.Valid)
{ {
@ -49,13 +52,25 @@ public class SkipIntroController : ControllerBase
return intro; return intro;
} }
/// <summary>Lookup and return the intro timestamps for the provided item.</summary> /// <summary>Lookup and return the skippable timestamps for the provided item.</summary>
/// <param name="id">Unique identifier of this episode.</param> /// <param name="id">Unique identifier of this episode.</param>
/// <param name="mode">Mode.</param>
/// <returns>Intro object if the provided item has an intro, null otherwise.</returns> /// <returns>Intro object if the provided item has an intro, null otherwise.</returns>
private Intro? GetIntro(Guid id) private Intro? GetIntro(Guid id, AnalysisMode mode)
{ {
// Returns a copy to avoid mutating the original Intro object stored in the dictionary. try
return Plugin.Instance!.Intros.TryGetValue(id, out var intro) ? new Intro(intro) : null; {
var timestamp = mode == AnalysisMode.Introduction ?
Plugin.Instance!.Intros[id] :
Plugin.Instance!.Credits[id];
// A copy is returned to avoid mutating the original Intro object stored in the dictionary.
return new(timestamp);
}
catch (KeyNotFoundException)
{
return null;
}
} }
/// <summary> /// <summary>