aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/Drawing/IImageGenerator.cs
blob: 773db02cb92db0960277cab71d94c43db597a70f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
using System.Collections.Generic;

namespace MediaBrowser.Controller.Drawing;

/// <summary>
/// Interface for an image generator.
/// </summary>
public interface IImageGenerator
{
    /// <summary>
    /// Gets the supported generated images of the image generator.
    /// </summary>
    /// <returns>The supported generated image types.</returns>
    IReadOnlyList<GeneratedImageType> GetSupportedImages();

    /// <summary>
    /// Generates a splashscreen.
    /// </summary>
    /// <param name="imageTypeType">The image to generate.</param>
    /// <param name="outputPath">The path where the splashscreen should be saved.</param>
    void Generate(GeneratedImageType imageTypeType, string outputPath);
}