diff options
| author | 1hitsong <3330318+1hitsong@users.noreply.github.com> | 2022-09-17 17:37:38 -0400 |
|---|---|---|
| committer | 1hitsong <3330318+1hitsong@users.noreply.github.com> | 2022-09-17 17:37:38 -0400 |
| commit | c65819221d9a84ec0ae69a243fdcb17bce7aa65f (patch) | |
| tree | 5980490c8c2be7c5ac5f7d7f3ab0e681245ddcf2 /MediaBrowser.Controller/Lyrics | |
| parent | 29932466a9e75f9cf54332be9bb9d39dce238d07 (diff) | |
Code cleanups. Remove pragma commands
Diffstat (limited to 'MediaBrowser.Controller/Lyrics')
| -rw-r--r-- | MediaBrowser.Controller/Lyrics/ILyricManager.cs | 36 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Lyrics/ILyricProvider.cs | 39 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Lyrics/Lyric.cs | 34 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Lyrics/LyricInfo.cs | 39 | ||||
| -rw-r--r-- | MediaBrowser.Controller/Lyrics/LyricResponse.cs | 27 |
5 files changed, 88 insertions, 87 deletions
diff --git a/MediaBrowser.Controller/Lyrics/ILyricManager.cs b/MediaBrowser.Controller/Lyrics/ILyricManager.cs index c0f78d177..dad0250f6 100644 --- a/MediaBrowser.Controller/Lyrics/ILyricManager.cs +++ b/MediaBrowser.Controller/Lyrics/ILyricManager.cs @@ -1,23 +1,23 @@ -#pragma warning disable CS1591 - using MediaBrowser.Controller.Entities; -namespace MediaBrowser.Controller.Lyrics +namespace MediaBrowser.Controller.Lyrics; + +/// <summary> +/// Interface ILyricManager. +/// </summary> +public interface ILyricManager { - public interface ILyricManager - { - /// <summary> - /// Gets the lyrics. - /// </summary> - /// <param name="item">The media item.</param> - /// <returns>Lyrics for passed item.</returns> - LyricResponse GetLyrics(BaseItem item); + /// <summary> + /// Gets the lyrics. + /// </summary> + /// <param name="item">The media item.</param> + /// <returns>Lyrics for passed item.</returns> + LyricResponse GetLyrics(BaseItem item); - /// <summary> - /// Checks if requested item has a matching local lyric file. - /// </summary> - /// <param name="item">The media item.</param> - /// <returns>True if item has a matching lyric file; otherwise false.</returns> - bool HasLyricFile(BaseItem item); - } + /// <summary> + /// Checks if requested item has a matching local lyric file. + /// </summary> + /// <param name="item">The media item.</param> + /// <returns>True if item has a matching lyric file; otherwise false.</returns> + bool HasLyricFile(BaseItem item); } diff --git a/MediaBrowser.Controller/Lyrics/ILyricProvider.cs b/MediaBrowser.Controller/Lyrics/ILyricProvider.cs index 5e677ab26..1b52de255 100644 --- a/MediaBrowser.Controller/Lyrics/ILyricProvider.cs +++ b/MediaBrowser.Controller/Lyrics/ILyricProvider.cs @@ -1,29 +1,28 @@ using System.Collections.Generic; using MediaBrowser.Controller.Entities; -namespace MediaBrowser.Controller.Lyrics +namespace MediaBrowser.Controller.Lyrics; + +/// <summary> +/// Interface ILyricsProvider. +/// </summary> +public interface ILyricProvider { /// <summary> - /// Interface ILyricsProvider. + /// Gets a value indicating the provider name. /// </summary> - public interface ILyricProvider - { - /// <summary> - /// Gets a value indicating the provider name. - /// </summary> - string Name { get; } + string Name { get; } - /// <summary> - /// Gets the supported media types for this provider. - /// </summary> - /// <value>The supported media types.</value> - IEnumerable<string> SupportedMediaTypes { get; } + /// <summary> + /// Gets the supported media types for this provider. + /// </summary> + /// <value>The supported media types.</value> + IEnumerable<string> SupportedMediaTypes { get; } - /// <summary> - /// Gets the lyrics. - /// </summary> - /// <param name="item">The media item.</param> - /// <returns>If found, returns lyrics for passed item; otherwise, null.</returns> - LyricResponse? GetLyrics(BaseItem item); - } + /// <summary> + /// Gets the lyrics. + /// </summary> + /// <param name="item">The media item.</param> + /// <returns>If found, returns lyrics for passed item; otherwise, null.</returns> + LyricResponse? GetLyrics(BaseItem item); } diff --git a/MediaBrowser.Controller/Lyrics/Lyric.cs b/MediaBrowser.Controller/Lyrics/Lyric.cs index 35cdabbb9..f39fbb022 100644 --- a/MediaBrowser.Controller/Lyrics/Lyric.cs +++ b/MediaBrowser.Controller/Lyrics/Lyric.cs @@ -1,18 +1,28 @@ -namespace MediaBrowser.Controller.Lyrics +namespace MediaBrowser.Controller.Lyrics; + +/// <summary> +/// Lyric model. +/// </summary> +public class Lyric { /// <summary> - /// Lyric model. + /// Initializes a new instance of the <see cref="Lyric"/> class. /// </summary> - public class Lyric + /// <param name="start">The lyric start time in ticks.</param> + /// <param name="text">The lyric text.</param> + public Lyric(string text, long? start = null) { - /// <summary> - /// Gets or sets the start time in ticks. - /// </summary> - public long? Start { get; set; } - - /// <summary> - /// Gets or sets the text. - /// </summary> - public string Text { get; set; } = string.Empty; + Start = start; + Text = text; } + + /// <summary> + /// Gets the start time in ticks. + /// </summary> + public long? Start { get; } + + /// <summary> + /// Gets the text. + /// </summary> + public string Text { get; } } diff --git a/MediaBrowser.Controller/Lyrics/LyricInfo.cs b/MediaBrowser.Controller/Lyrics/LyricInfo.cs index ae831b4d2..61e205b6c 100644 --- a/MediaBrowser.Controller/Lyrics/LyricInfo.cs +++ b/MediaBrowser.Controller/Lyrics/LyricInfo.cs @@ -1,34 +1,29 @@ using System.IO; -using System.Linq; -namespace MediaBrowser.Controller.Lyrics +namespace MediaBrowser.Controller.Lyrics; + +/// <summary> +/// Lyric helper methods. +/// </summary> +public static class LyricInfo { /// <summary> - /// Lyric helper methods. + /// Gets matching lyric file for a requested item. /// </summary> - public static class LyricInfo + /// <param name="lyricProvider">The lyricProvider interface to use.</param> + /// <param name="itemPath">Path of requested item.</param> + /// <returns>Lyric file path if passed lyric provider's supported media type is found; otherwise, null.</returns> + public static string? GetLyricFilePath(ILyricProvider lyricProvider, string itemPath) { - /// <summary> - /// Gets matching lyric file for a requested item. - /// </summary> - /// <param name="lyricProvider">The lyricProvider interface to use.</param> - /// <param name="itemPath">Path of requested item.</param> - /// <returns>Lyric file path if passed lyric provider's supported media type is found; otherwise, null.</returns> - public static string? GetLyricFilePath(ILyricProvider lyricProvider, string itemPath) + foreach (string lyricFileExtension in lyricProvider.SupportedMediaTypes) { - if (lyricProvider.SupportedMediaTypes.Any()) + var lyricFilePath = Path.ChangeExtension(itemPath, lyricFileExtension); + if (File.Exists(lyricFilePath)) { - foreach (string lyricFileExtension in lyricProvider.SupportedMediaTypes) - { - string lyricFilePath = @Path.ChangeExtension(itemPath, lyricFileExtension); - if (System.IO.File.Exists(lyricFilePath)) - { - return lyricFilePath; - } - } + return lyricFilePath; } - - return null; } + + return null; } } diff --git a/MediaBrowser.Controller/Lyrics/LyricResponse.cs b/MediaBrowser.Controller/Lyrics/LyricResponse.cs index 796ca3bc3..e18cb1101 100644 --- a/MediaBrowser.Controller/Lyrics/LyricResponse.cs +++ b/MediaBrowser.Controller/Lyrics/LyricResponse.cs @@ -1,22 +1,19 @@ -#nullable disable - using System.Collections.Generic; -namespace MediaBrowser.Controller.Lyrics +namespace MediaBrowser.Controller.Lyrics; + +/// <summary> +/// LyricResponse model. +/// </summary> +public class LyricResponse { /// <summary> - /// LyricResponse model. + /// Gets or sets Metadata. /// </summary> - public class LyricResponse - { - /// <summary> - /// Gets or sets Metadata. - /// </summary> - public IDictionary<string, string> Metadata { get; set; } + public IDictionary<string, string>? Metadata { get; set; } - /// <summary> - /// Gets or sets Lyrics. - /// </summary> - public IEnumerable<Lyric> Lyrics { get; set; } - } + /// <summary> + /// Gets or sets Lyrics. + /// </summary> + public IEnumerable<Lyric>? Lyrics { get; set; } } |
