Interface IImageEnhancer
Namespace: MediaBrowser.Controller.Providers
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IImageEnhancerProperties
Priority
Gets the priority or order in which this enhancer should be run.
Declaration
MetadataProviderPriority Priority { get; }Property Value
| Type | Description |
|---|---|
| MetadataProviderPriority | The priority. |
Methods
EnhanceImageAsync(BaseItem, String, String, ImageType, Int32)
Enhances the image async.
Declaration
Task EnhanceImageAsync(BaseItem item, string inputFile, string outputFile, ImageType imageType, int imageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| BaseItem | item | The item. |
| System.String | inputFile | The input file. |
| System.String | outputFile | The output file. |
| ImageType | imageType | Type of the image. |
| System.Int32 | imageIndex | Index of the image. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task{Image}. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException |
GetConfigurationCacheKey(BaseItem, ImageType)
Return a key incorporating all configuration information related to this item
Declaration
string GetConfigurationCacheKey(BaseItem item, ImageType imageType)Parameters
| Type | Name | Description |
|---|---|---|
| BaseItem | item | The item. |
| ImageType | imageType | Type of the image. |
Returns
| Type | Description |
|---|---|
| System.String | Cache key relating to the current state of this item and configuration |
GetEnhancedImageInfo(BaseItem, String, ImageType, Int32)
Declaration
EnhancedImageInfo GetEnhancedImageInfo(BaseItem item, string inputFile, ImageType imageType, int imageIndex)Parameters
| Type | Name | Description |
|---|---|---|
| BaseItem | item | |
| System.String | inputFile | |
| ImageType | imageType | |
| System.Int32 | imageIndex |
Returns
| Type | Description |
|---|---|
| EnhancedImageInfo |
GetEnhancedImageSize(BaseItem, ImageType, Int32, ImageSize)
Gets the size of the enhanced image.
Declaration
ImageSize GetEnhancedImageSize(BaseItem item, ImageType imageType, int imageIndex, ImageSize originalImageSize)Parameters
| Type | Name | Description |
|---|---|---|
| BaseItem | item | The item. |
| ImageType | imageType | Type of the image. |
| System.Int32 | imageIndex | Index of the image. |
| ImageSize | originalImageSize | Size of the original image. |
Returns
| Type | Description |
|---|---|
| ImageSize | ImageSize. |
Supports(BaseItem, ImageType)
Return true only if the given image for the given item will be enhanced by this enhancer.
Declaration
bool Supports(BaseItem item, ImageType imageType)Parameters
| Type | Name | Description |
|---|---|---|
| BaseItem | item | The item. |
| ImageType | imageType | Type of the image. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|