Interface IImageEncoder

Namespace: MediaBrowser.Controller.Drawing
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IImageEncoder

Properties

Name

Gets the name.

Declaration
string Name { get; }
Property Value
Type Description
System.String

The name.

SupportedInputFormats

Gets the supported input formats.

Declaration
string[] SupportedInputFormats { get; }
Property Value
Type Description
System.String[]

The supported input formats.

SupportedOutputFormats

Gets the supported output formats.

Declaration
ImageFormat[] SupportedOutputFormats { get; }
Property Value
Type Description
ImageFormat[]

The supported output formats.

SupportsImageCollageCreation

Gets a value indicating whether [supports image collage creation].

Declaration
bool SupportsImageCollageCreation { get; }
Property Value
Type Description
System.Boolean

true if [supports image collage creation]; otherwise, false.

SupportsImageEncoding

Gets a value indicating whether [supports image encoding].

Declaration
bool SupportsImageEncoding { get; }
Property Value
Type Description
System.Boolean

true if [supports image encoding]; otherwise, false.

Methods

CreateImageCollage(ImageCollageOptions)

Creates the image collage.

Declaration
void CreateImageCollage(ImageCollageOptions options)
Parameters
Type Name Description
ImageCollageOptions options

The options.

EncodeImage(String, String, Boolean, Nullable<ImageOrientation>, Int32, ImageProcessingOptions, ImageFormat)

Encodes the image.

Declaration
string EncodeImage(string inputPath, string outputPath, bool autoOrient, ImageOrientation? orientation, int quality, ImageProcessingOptions options, ImageFormat outputFormat)
Parameters
Type Name Description
System.String inputPath
System.String outputPath
System.Boolean autoOrient
System.Nullable<ImageOrientation> orientation
System.Int32 quality
ImageProcessingOptions options
ImageFormat outputFormat
Returns
Type Description
System.String

GetImageSize(String)

Declaration
(ImageSize, ImageOrientation? ) GetImageSize(string path)
Parameters
Type Name Description
System.String path
Returns
Type Description
System.ValueTuple<ImageSize, System.Nullable<ImageOrientation>>

Extension Methods