diff options
Diffstat (limited to 'MediaBrowser.Providers/Lyric/ILyricProvider.cs')
| -rw-r--r-- | MediaBrowser.Providers/Lyric/ILyricProvider.cs | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/MediaBrowser.Providers/Lyric/ILyricProvider.cs b/MediaBrowser.Providers/Lyric/ILyricProvider.cs new file mode 100644 index 000000000..27ceba72b --- /dev/null +++ b/MediaBrowser.Providers/Lyric/ILyricProvider.cs @@ -0,0 +1,36 @@ +using System.Threading.Tasks; +using MediaBrowser.Controller.Entities; +using MediaBrowser.Controller.Resolvers; + +namespace MediaBrowser.Providers.Lyric; + +/// <summary> +/// Interface ILyricsProvider. +/// </summary> +public interface ILyricProvider +{ + /// <summary> + /// Gets a value indicating the provider name. + /// </summary> + string Name { get; } + + /// <summary> + /// Gets the priority. + /// </summary> + /// <value>The priority.</value> + ResolverPriority Priority { get; } + + /// <summary> + /// Checks if an item has lyrics available. + /// </summary> + /// <param name="item">The media item.</param> + /// <returns>Whether lyrics where found or not.</returns> + bool HasLyrics(BaseItem item); + + /// <summary> + /// Gets the lyrics. + /// </summary> + /// <param name="item">The media item.</param> + /// <returns>A task representing found lyrics.</returns> + Task<LyricFile?> GetLyrics(BaseItem item); +} |
