2014-11-09 04:18:14 +01:00
using MediaBrowser.Model.Entities ;
2016-10-25 21:02:04 +02:00
using MediaBrowser.Model.Services ;
2013-02-21 02:33:05 +01:00
namespace MediaBrowser.Api.Images
{
/// <summary>
/// Class ImageRequest
/// </summary>
public class ImageRequest : DeleteImageRequest
{
/// <summary>
/// The max width
/// </summary>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "MaxWidth", Description = "The maximum image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-21 08:00:04 +01:00
public int? MaxWidth { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// The max height
/// </summary>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "MaxHeight", Description = "The maximum image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-21 08:00:04 +01:00
public int? MaxHeight { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// The width
/// </summary>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Width", Description = "The fixed image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-21 08:00:04 +01:00
public int? Width { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// The height
/// </summary>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Height", Description = "The fixed image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-21 08:00:04 +01:00
public int? Height { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// Gets or sets the quality.
/// </summary>
/// <value>The quality.</value>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Quality", Description = "Optional quality setting, from 0-100. Defaults to 90 and should suffice in most cases.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
2013-02-21 02:33:05 +01:00
public int? Quality { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// Gets or sets the tag.
/// </summary>
/// <value>The tag.</value>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Tag", Description = "Optional. Supply the cache tag from the item object to receive strong caching headers.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
2013-02-21 02:33:05 +01:00
public string Tag { get ; set ; }
2013-06-05 03:19:25 +02:00
2013-06-05 14:35:18 +02:00
[ApiMember(Name = "CropWhitespace", Description = "Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
2013-06-05 03:19:25 +02:00
public bool? CropWhitespace { get ; set ; }
2013-06-05 14:35:18 +02:00
[ApiMember(Name = "EnableImageEnhancers", Description = "Enable or disable image enhancers such as cover art.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool EnableImageEnhancers { get ; set ; }
2013-09-19 17:12:28 +02:00
[ApiMember(Name = "Format", Description = "Determines the output foramt of the image - original,gif,jpg,png", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
2014-11-09 04:18:14 +01:00
public string Format { get ; set ; }
2013-09-19 19:45:48 +02:00
2013-10-02 17:32:11 +02:00
[ApiMember(Name = "AddPlayedIndicator", Description = "Optional. Add a played indicator", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
public bool AddPlayedIndicator { get ; set ; }
2013-09-21 17:06:00 +02:00
2014-01-01 19:26:31 +01:00
[ApiMember(Name = "PercentPlayed", Description = "Optional percent to render for the percent played overlay", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public double? PercentPlayed { get ; set ; }
[ApiMember(Name = "UnplayedCount", Description = "Optional unplayed count overlay to render", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? UnplayedCount { get ; set ; }
2013-09-21 17:06:00 +02:00
[ApiMember(Name = "BackgroundColor", Description = "Optional. Apply a background color for transparent images.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string BackgroundColor { get ; set ; }
2016-02-23 20:48:58 +01:00
[ApiMember(Name = "ForegroundLayer", Description = "Optional. Apply a foreground layer on top of the image.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string ForegroundLayer { get ; set ; }
2013-06-05 14:35:18 +02:00
public ImageRequest ( )
{
EnableImageEnhancers = true ;
}
2013-02-21 02:33:05 +01:00
}
/// <summary>
/// Class DeleteImageRequest
/// </summary>
public class DeleteImageRequest
{
/// <summary>
/// Gets or sets the type of the image.
/// </summary>
/// <value>The type of the image.</value>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
[ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
[ApiMember(Name = "Type", Description = "Image Type", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
2013-02-21 02:33:05 +01:00
public ImageType Type { get ; set ; }
2013-03-08 22:06:02 +01:00
2013-02-21 02:33:05 +01:00
/// <summary>
/// Gets or sets the index.
/// </summary>
/// <value>The index.</value>
2013-03-08 22:06:02 +01:00
[ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
[ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "POST")]
[ApiMember(Name = "Index", Description = "Image Index", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "DELETE")]
2013-02-21 02:33:05 +01:00
public int? Index { get ; set ; }
}
}