jellyfin-server/MediaBrowser.Controller/Drawing/IImageProcessor.cs

117 lines
4.1 KiB
C#
Raw Normal View History

2015-11-12 19:26:02 +00:00
using System;
using MediaBrowser.Controller.Entities;
2013-09-18 18:49:06 +00:00
using MediaBrowser.Controller.Providers;
using MediaBrowser.Model.Drawing;
using MediaBrowser.Model.Entities;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
namespace MediaBrowser.Controller.Drawing
{
/// <summary>
/// Interface IImageProcessor
/// </summary>
public interface IImageProcessor
{
2015-04-08 14:38:02 +00:00
/// <summary>
/// Gets the supported input formats.
/// </summary>
/// <value>The supported input formats.</value>
string[] SupportedInputFormats { get; }
2015-11-12 19:26:02 +00:00
2013-09-18 18:49:06 +00:00
/// <summary>
/// Gets the image enhancers.
/// </summary>
/// <value>The image enhancers.</value>
IEnumerable<IImageEnhancer> ImageEnhancers { get; }
/// <summary>
/// Gets the size of the image.
/// </summary>
2015-02-28 13:42:47 +00:00
/// <param name="info">The information.</param>
2013-09-18 18:49:06 +00:00
/// <returns>ImageSize.</returns>
2015-02-28 13:42:47 +00:00
ImageSize GetImageSize(ItemImageInfo info);
2013-09-18 18:49:06 +00:00
2015-10-16 19:25:19 +00:00
/// <summary>
/// Gets the size of the image.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>ImageSize.</returns>
ImageSize GetImageSize(string path);
2015-11-12 19:26:02 +00:00
2013-09-18 18:49:06 +00:00
/// <summary>
/// Adds the parts.
/// </summary>
/// <param name="enhancers">The enhancers.</param>
void AddParts(IEnumerable<IImageEnhancer> enhancers);
/// <summary>
/// Gets the supported enhancers.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="imageType">Type of the image.</param>
/// <returns>IEnumerable{IImageEnhancer}.</returns>
2013-12-19 21:51:32 +00:00
IEnumerable<IImageEnhancer> GetSupportedEnhancers(IHasImages item, ImageType imageType);
2013-09-18 18:49:06 +00:00
/// <summary>
/// Gets the image cache tag.
/// </summary>
/// <param name="item">The item.</param>
2014-02-07 20:30:41 +00:00
/// <param name="image">The image.</param>
2013-09-18 18:49:06 +00:00
/// <returns>Guid.</returns>
2014-05-08 20:09:53 +00:00
string GetImageCacheTag(IHasImages item, ItemImageInfo image);
2013-09-18 18:49:06 +00:00
/// <summary>
/// Gets the image cache tag.
/// </summary>
/// <param name="item">The item.</param>
2014-06-18 15:12:20 +00:00
/// <param name="image">The image.</param>
2013-09-18 18:49:06 +00:00
/// <param name="imageEnhancers">The image enhancers.</param>
/// <returns>Guid.</returns>
2014-06-18 15:12:20 +00:00
string GetImageCacheTag(IHasImages item, ItemImageInfo image, List<IImageEnhancer> imageEnhancers);
2013-09-18 18:49:06 +00:00
/// <summary>
/// Processes the image.
/// </summary>
2013-09-19 15:12:28 +00:00
/// <param name="options">The options.</param>
2013-09-18 18:49:06 +00:00
/// <param name="toStream">To stream.</param>
/// <returns>Task.</returns>
2013-09-19 15:12:28 +00:00
Task ProcessImage(ImageProcessingOptions options, Stream toStream);
2015-11-12 19:26:02 +00:00
2014-07-17 22:21:35 +00:00
/// <summary>
/// Processes the image.
/// </summary>
/// <param name="options">The options.</param>
/// <returns>Task.</returns>
2015-11-12 19:26:02 +00:00
Task<Tuple<string, string>> ProcessImage(ImageProcessingOptions options);
/// <summary>
/// Gets the enhanced image.
/// </summary>
/// <param name="item">The item.</param>
/// <param name="imageType">Type of the image.</param>
/// <param name="imageIndex">Index of the image.</param>
/// <returns>Task{System.String}.</returns>
2013-12-19 21:51:32 +00:00
Task<string> GetEnhancedImage(IHasImages item, ImageType imageType, int imageIndex);
/// <summary>
/// Gets the supported image output formats.
/// </summary>
/// <returns>ImageOutputFormat[].</returns>
2014-11-29 19:51:30 +00:00
ImageFormat[] GetSupportedImageOutputFormats();
2015-04-08 14:38:02 +00:00
/// <summary>
/// Creates the image collage.
/// </summary>
/// <param name="options">The options.</param>
Task CreateImageCollage(ImageCollageOptions options);
2015-10-26 05:29:32 +00:00
/// <summary>
/// Gets a value indicating whether [supports image collage creation].
/// </summary>
/// <value><c>true</c> if [supports image collage creation]; otherwise, <c>false</c>.</value>
bool SupportsImageCollageCreation { get; }
2013-09-18 18:49:06 +00:00
}
}