Class EncoderInfo

Describes an image codec.

Inheritance

System.Object

CodecInfo

EncoderInfo

Implements

System.IEquatable<CodecInfo>

IImageEncoderInfo

IImageCodecInfo

System.IEquatable<EncoderInfo>

Inherited Members

CodecInfo.Deconstruct(String, IEnumerable<String>, IEnumerable<String>)

CodecInfo.Name

CodecInfo.MimeTypes

CodecInfo.FileExtensions

Namespace: PhotoSauce.MagicScaler

Assembly: PhotoSauce.MagicScaler.dll

Syntax

public sealed class EncoderInfo : CodecInfo, IImageEncoderInfo, IImageCodecInfo

Constructors

EncoderInfo(String, IEnumerable<String>, IEnumerable<String>, IEnumerable<Guid>, IEncoderOptions, Func<Stream, IEncoderOptions, IImageEncoder>, Boolean, Boolean, Boolean)

The friendly name of the codec.

Declaration

public EncoderInfo(string Name, IEnumerable<string> MimeTypes, IEnumerable<string> FileExtensions, IEnumerable<Guid> PixelFormats, IEncoderOptions DefaultOptions, Func<Stream, IEncoderOptions, IImageEncoder> Factory, bool SupportsMultiFrame, bool SupportsAnimation, bool SupportsColorProfile)

Parameters

Type	Name	Description
System.String	Name	The friendly name of the codec.
System.Collections.Generic.IEnumerable<System.String>	MimeTypes	A list of MIME types supported by the codec.
System.Collections.Generic.IEnumerable<System.String>	FileExtensions	A list of file extensions supported by the codec.
System.Collections.Generic.IEnumerable<System.Guid>	PixelFormats	A list of the pixel format GUIDs supported by this encoder.
IEncoderOptions	DefaultOptions	Default codec options to be used for this encoder in the absence of per-instance overrides.
System.Func<System.IO.Stream, IEncoderOptions, IImageEncoder>	Factory	A delegate capable of creating an instance of this encoder to write to a given System.IO.Stream data source.
System.Boolean	SupportsMultiFrame	True if the codec supports transparency, otherwise false.
System.Boolean	SupportsAnimation	True if the codec supports animation sequences, otherwise false.
System.Boolean	SupportsColorProfile	True if the codec supports ICC color profiles, otherwise false.

Properties

DefaultOptions

Default codec options to be used for this encoder in the absence of per-instance overrides.

Declaration

public IEncoderOptions DefaultOptions { get; set; }

Property Value

Type	Description
IEncoderOptions

EqualityContract

Declaration

protected override Type EqualityContract { get; }

Property Value

Type	Description
System.Type

Overrides

CodecInfo.EqualityContract

Factory

A delegate capable of creating an instance of this encoder to write to a given System.IO.Stream data source.

Declaration

public Func<Stream, IEncoderOptions, IImageEncoder> Factory { get; set; }

Property Value

Type	Description
System.Func<System.IO.Stream, IEncoderOptions, IImageEncoder>

PixelFormats

A list of the pixel format GUIDs supported by this encoder.

Declaration

public IEnumerable<Guid> PixelFormats { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Guid>

SupportsAnimation

True if the codec supports animation sequences, otherwise false.

Declaration

public bool SupportsAnimation { get; set; }

Property Value

Type	Description
System.Boolean

SupportsColorProfile

True if the codec supports ICC color profiles, otherwise false.

Declaration

public bool SupportsColorProfile { get; set; }

Property Value

Type	Description
System.Boolean

SupportsMultiFrame

True if the codec supports transparency, otherwise false.

Declaration

public bool SupportsMultiFrame { get; set; }

Property Value

Type	Description
System.Boolean

Methods

<Clone>$()

Declaration

public override CodecInfo <Clone>$()

Returns

Type	Description
CodecInfo

Overrides

CodecInfo.<Clone>$()

Deconstruct(out String, out IEnumerable<String>, out IEnumerable<String>, out IEnumerable<Guid>, out IEncoderOptions, out Func<Stream, IEncoderOptions, IImageEncoder>, out Boolean, out Boolean, out Boolean)

Declaration

public void Deconstruct(out string Name, out IEnumerable<string> MimeTypes, out IEnumerable<string> FileExtensions, out IEnumerable<Guid> PixelFormats, out IEncoderOptions DefaultOptions, out Func<Stream, IEncoderOptions, IImageEncoder> Factory, out bool SupportsMultiFrame, out bool SupportsAnimation, out bool SupportsColorProfile)

Parameters

Type	Name	Description
System.String	Name
System.Collections.Generic.IEnumerable<System.String>	MimeTypes
System.Collections.Generic.IEnumerable<System.String>	FileExtensions
System.Collections.Generic.IEnumerable<System.Guid>	PixelFormats
IEncoderOptions	DefaultOptions
System.Func<System.IO.Stream, IEncoderOptions, IImageEncoder>	Factory
System.Boolean	SupportsMultiFrame
System.Boolean	SupportsAnimation
System.Boolean	SupportsColorProfile

Equals(CodecInfo)

Declaration

public sealed override bool Equals(CodecInfo other)

Parameters

Type	Name	Description
CodecInfo	other

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.Equals(CodecInfo)

Equals(EncoderInfo)

Declaration

public bool Equals(EncoderInfo other)

Parameters

Type	Name	Description
EncoderInfo	other

Returns

Type	Description
System.Boolean

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.Equals(Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

CodecInfo.GetHashCode()

PrintMembers(StringBuilder)

Declaration

protected override bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
System.Text.StringBuilder	builder

Returns

Type	Description
System.Boolean

Overrides

CodecInfo.PrintMembers(StringBuilder)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

CodecInfo.ToString()

Operators

Equality(EncoderInfo, EncoderInfo)

Declaration

public static bool operator ==(EncoderInfo left, EncoderInfo right)

Parameters

Type	Name	Description
EncoderInfo	left
EncoderInfo	right

Returns

Type	Description
System.Boolean

Inequality(EncoderInfo, EncoderInfo)

Declaration

public static bool operator !=(EncoderInfo left, EncoderInfo right)

Parameters

Type	Name	Description
EncoderInfo	left
EncoderInfo	right

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<>

IImageEncoderInfo

IImageCodecInfo

System.IEquatable<>