jellyfin/MediaBrowser.Controller/Lyrics/ILyricManager.cs

25 lines
725 B
C#
Raw Normal View History

2022-09-22 05:13:53 -07:00
using System.Threading.Tasks;
2022-09-15 17:49:25 -07:00
using MediaBrowser.Controller.Entities;
2022-09-17 14:37:38 -07:00
namespace MediaBrowser.Controller.Lyrics;
/// <summary>
/// Interface ILyricManager.
/// </summary>
public interface ILyricManager
2022-09-15 17:49:25 -07:00
{
2022-09-17 14:37:38 -07:00
/// <summary>
/// Gets the lyrics.
/// </summary>
/// <param name="item">The media item.</param>
2022-09-22 05:13:53 -07:00
/// <returns>A task representing found lyrics the passed item.</returns>
Task<LyricResponse?> GetLyrics(BaseItem item);
2022-09-15 17:49:25 -07:00
2022-09-17 14:37:38 -07:00
/// <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);
2022-09-15 17:49:25 -07:00
}