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.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ImageMetadataExtensions.CloneCurMetadata(ImageFrameMetadata)

ImageMetadataExtensions.CloneGifMetadata(ImageFrameMetadata)

ImageMetadataExtensions.CloneIcoMetadata(ImageFrameMetadata)

ImageMetadataExtensions.ClonePngMetadata(ImageFrameMetadata)

ImageMetadataExtensions.CloneTiffMetadata(ImageFrameMetadata)

ImageMetadataExtensions.CloneWebpMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetCurMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetGifMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetIcoMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetPngMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetTiffMetadata(ImageFrameMetadata)

ImageMetadataExtensions.GetWebpMetadata(ImageFrameMetadata)

Properties

CicpProfile

Gets or sets the CICP profile

public CicpProfile? CicpProfile { get; set; }

Property Value

CicpProfile

DecodedImageFormat

Gets the original format, if any, the image was decode from.

public IImageFormat? DecodedImageFormat { get; }

Property Value

IImageFormat

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

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

Creates a new instance the metadata value associated with the specified key. The instance is created from a clone generated via GetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata>).

public TFormatFrameMetadata CloneFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata> key) where TFormatMetadata : class where TFormatFrameMetadata : class, IFormatFrameMetadata<TFormatFrameMetadata>

Parameters

key IImageFormat<TFormatMetadata, TFormatFrameMetadata>

The key of the value to get.

Returns

TFormatFrameMetadata

The TFormatMetadata.

Type Parameters

TFormatMetadata

The type of metadata.

TFormatFrameMetadata

The type of format frame metadata.

DeepClone()

Creates a new ImageFrameMetadata that is a deep copy of the current instance.

public ImageFrameMetadata DeepClone()

Returns

ImageFrameMetadata

The ImageFrameMetadata.

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

Gets the metadata value associated with the specified key.
If none is found, an instance is created either by conversion from the decoded image format metadata or the requested format default constructor. This instance will be added to the metadata for future requests.

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

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.

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

Sets the metadata value associated with the specified key.

public void SetFormatMetadata<TFormatMetadata, TFormatFrameMetadata>(IImageFormat<TFormatMetadata, TFormatFrameMetadata> key, TFormatFrameMetadata value) where TFormatMetadata : class where TFormatFrameMetadata : class, IFormatFrameMetadata<TFormatFrameMetadata>

Parameters

key IImageFormat<TFormatMetadata, TFormatFrameMetadata>

The key of the value to set.

value TFormatFrameMetadata

The value to set.

Type Parameters

TFormatMetadata

The type of format metadata.

TFormatFrameMetadata

The type of format frame metadata.