95 lines
3.9 KiB
C#
95 lines
3.9 KiB
C#
using MediaBrowser.Controller.Entities;
|
|
using MediaBrowser.Controller.Providers;
|
|
using MediaBrowser.Model.Drawing;
|
|
using MediaBrowser.Model.Entities;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace MediaBrowser.Controller.Drawing
|
|
{
|
|
/// <summary>
|
|
/// Interface IImageProcessor
|
|
/// </summary>
|
|
public interface IImageProcessor
|
|
{
|
|
/// <summary>
|
|
/// Gets the image enhancers.
|
|
/// </summary>
|
|
/// <value>The image enhancers.</value>
|
|
IEnumerable<IImageEnhancer> ImageEnhancers { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the size of the image.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <returns>ImageSize.</returns>
|
|
ImageSize GetImageSize(string path);
|
|
|
|
/// <summary>
|
|
/// Gets the size of the image.
|
|
/// </summary>
|
|
/// <param name="path">The path.</param>
|
|
/// <param name="imageDateModified">The image date modified.</param>
|
|
/// <returns>ImageSize.</returns>
|
|
ImageSize GetImageSize(string path, DateTime imageDateModified);
|
|
|
|
/// <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>
|
|
IEnumerable<IImageEnhancer> GetSupportedEnhancers(BaseItem item, ImageType imageType);
|
|
|
|
/// <summary>
|
|
/// Gets the image cache tag.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="imageType">Type of the image.</param>
|
|
/// <param name="imagePath">The image path.</param>
|
|
/// <returns>Guid.</returns>
|
|
Guid GetImageCacheTag(BaseItem item, ImageType imageType, string imagePath);
|
|
|
|
/// <summary>
|
|
/// Gets the image cache tag.
|
|
/// </summary>
|
|
/// <param name="item">The item.</param>
|
|
/// <param name="imageType">Type of the image.</param>
|
|
/// <param name="originalImagePath">The original image path.</param>
|
|
/// <param name="dateModified">The date modified.</param>
|
|
/// <param name="imageEnhancers">The image enhancers.</param>
|
|
/// <returns>Guid.</returns>
|
|
Guid GetImageCacheTag(BaseItem item, ImageType imageType, string originalImagePath, DateTime dateModified,
|
|
IEnumerable<IImageEnhancer> imageEnhancers);
|
|
|
|
/// <summary>
|
|
/// Processes the image.
|
|
/// </summary>
|
|
/// <param name="entity">The entity.</param>
|
|
/// <param name="imageType">Type of the image.</param>
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
/// <param name="originalImagePath">The original image path.</param>
|
|
/// <param name="cropWhitespace">if set to <c>true</c> [crop whitespace].</param>
|
|
/// <param name="dateModified">The date modified.</param>
|
|
/// <param name="toStream">To stream.</param>
|
|
/// <param name="width">The width.</param>
|
|
/// <param name="height">The height.</param>
|
|
/// <param name="maxWidth">Width of the max.</param>
|
|
/// <param name="maxHeight">Height of the max.</param>
|
|
/// <param name="quality">The quality.</param>
|
|
/// <param name="enhancers">The enhancers.</param>
|
|
/// <returns>Task.</returns>
|
|
Task ProcessImage(BaseItem entity, ImageType imageType, int imageIndex, string originalImagePath, bool cropWhitespace,
|
|
DateTime dateModified, Stream toStream, int? width, int? height, int? maxWidth, int? maxHeight,
|
|
int? quality, List<IImageEnhancer> enhancers);
|
|
}
|
|
}
|