aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Library/IMusicManager.cs
blob: 93073cc79b2a0da1a7af516ef786730ee90d3f4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#pragma warning disable CA1002, CS1591

using System.Collections.Generic;
using Jellyfin.Data.Entities;
using MediaBrowser.Controller.Dto;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Entities.Audio;

namespace MediaBrowser.Controller.Library
{
    public interface IMusicManager
    {
        /// <summary>
        /// Gets the instant mix from song.
        /// </summary>
        /// <param name="item">The item to use.</param>
        /// <param name="user">The user to use.</param>
        /// <param name="dtoOptions">The options to use.</param>
        /// <returns>List of items.</returns>
        List<BaseItem> GetInstantMixFromItem(BaseItem item, User? user, DtoOptions dtoOptions);

        /// <summary>
        /// Gets the instant mix from artist.
        /// </summary>
        /// <param name="artist">The artist to use.</param>
        /// <param name="user">The user to use.</param>
        /// <param name="dtoOptions">The options to use.</param>
        /// <returns>List of items.</returns>
        List<BaseItem> GetInstantMixFromArtist(MusicArtist artist, User? user, DtoOptions dtoOptions);

        /// <summary>
        /// Gets the instant mix from genre.
        /// </summary>
        /// <param name="genres">The genres to use.</param>
        /// <param name="user">The user to use.</param>
        /// <param name="dtoOptions">The options to use.</param>
        /// <returns>List of items.</returns>
        List<BaseItem> GetInstantMixFromGenres(IEnumerable<string> genres, User? user, DtoOptions dtoOptions);
    }
}