aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Lyrics/LyricSearchRequest.cs
blob: 48c442a55e365a6afaec2b91de427e515b2fc444 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
using System;
using System.Collections.Generic;
using MediaBrowser.Model.Entities;

namespace MediaBrowser.Model.Lyrics;

/// <summary>
/// Lyric search request.
/// </summary>
public class LyricSearchRequest : IHasProviderIds
{
    /// <summary>
    /// Gets or sets the media path.
    /// </summary>
    public string? MediaPath { get; set; }

    /// <summary>
    /// Gets or sets the artist name.
    /// </summary>
    public IReadOnlyList<string>? ArtistNames { get; set; }

    /// <summary>
    /// Gets or sets the album name.
    /// </summary>
    public string? AlbumName { get; set; }

    /// <summary>
    /// Gets or sets the song name.
    /// </summary>
    public string? SongName { get; set; }

    /// <summary>
    /// Gets or sets the track duration in ticks.
    /// </summary>
    public long? Duration { get; set; }

    /// <inheritdoc />
    public Dictionary<string, string> ProviderIds { get; set; } = new(StringComparer.OrdinalIgnoreCase);

    /// <summary>
    /// Gets or sets a value indicating whether to search all providers.
    /// </summary>
    public bool SearchAllProviders { get; set; } = true;

    /// <summary>
    /// Gets or sets the list of disabled lyric fetcher names.
    /// </summary>
    public IReadOnlyList<string> DisabledLyricFetchers { get; set; } = [];

    /// <summary>
    /// Gets or sets the order of lyric fetchers.
    /// </summary>
    public IReadOnlyList<string> LyricFetcherOrder { get; set; } = [];

    /// <summary>
    /// Gets or sets a value indicating whether this request is automated.
    /// </summary>
    public bool IsAutomated { get; set; }
}