Class ImageFrameMetadata

Namespace

SixLabors.ImageSharp.Metadata

Assembly

SixLabors.ImageSharp.dll

Encapsulates the metadata of an image frame.

public sealed class ImageFrameMetadata : IDeepCloneable<ImageFrameMetadata>

Inheritance

object

ImageFrameMetadata

Implements

IDeepCloneable<ImageFrameMetadata>

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MetadataExtensions.GetGifMetadata(ImageFrameMetadata)

MetadataExtensions.GetPngMetadata(ImageFrameMetadata)

MetadataExtensions.GetTiffMetadata(ImageFrameMetadata)

MetadataExtensions.GetWebpMetadata(ImageFrameMetadata)

MetadataExtensions.TryGetGifMetadata(ImageFrameMetadata, out GifFrameMetadata?)

MetadataExtensions.TryGetPngMetadata(ImageFrameMetadata, out PngFrameMetadata?)

MetadataExtensions.TryGetWebpFrameMetadata(ImageFrameMetadata, out WebpFrameMetadata?)

Properties

CicpProfile

Gets or sets the CICP profile

public CicpProfile? CicpProfile { get; set; }

Property Value

CicpProfile

ExifProfile

Gets or sets the Exif profile.

public ExifProfile? ExifProfile { get; set; }

Property Value

ExifProfile

IccProfile

Gets or sets the ICC profile.

public IccProfile? IccProfile { get; set; }

Property Value

IccProfile

IptcProfile

Gets or sets the iptc profile.

public IptcProfile? IptcProfile { get; set; }

Property Value

IptcProfile

XmpProfile

Gets or sets the XMP profile.

public XmpProfile? XmpProfile { get; set; }

Property Value

XmpProfile

Methods

DeepClone()

public ImageFrameMetadata DeepClone()

Returns

ImageFrameMetadata

GetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata>)

Gets the metadata value associated with the specified key. This method will always return a result creating a new instance and binding it to the frame metadata if none is found.

public TFormatFrameMetadata GetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata> key) where TFormatMetadata : class where TFormatFrameMetadata : class, IDeepCloneable

Parameters

key IImageFormat<TFormatMetadata, TFormatFrameMetadata>

The key of the value to get.

Returns

TFormatFrameMetadata

The TFormatFrameMetadata.

Type Parameters

TFormatMetadata

The type of format metadata.

TFormatFrameMetadata

The type of format frame metadata.

TryGetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata>, out TFormatFrameMetadata?)

Gets the metadata value associated with the specified key.

public bool TryGetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata> key, out TFormatFrameMetadata? metadata) where TFormatMetadata : class where TFormatFrameMetadata : class, IDeepCloneable

Parameters

key IImageFormat<TFormatMetadata, TFormatFrameMetadata>

The key of the value to get.

metadata TFormatFrameMetadata

When this method returns, contains the metadata associated with the specified key, if the key is found; otherwise, the default value for the type of the metadata parameter. This parameter is passed uninitialized.

Returns

bool

true if the frame metadata exists for the specified key; otherwise, false.

Type Parameters

TFormatMetadata

The type of format metadata.

TFormatFrameMetadata

The type of format frame metadata.