Class ImageFrameMetadata

Encapsulates the metadata of an image frame.

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()

Namespace: SixLabors.ImageSharp.Metadata

Assembly: SixLabors.ImageSharp.dll

Syntax

public sealed class ImageFrameMetadata : IDeepCloneable<ImageFrameMetadata>

Properties

CicpProfile

Gets or sets the CICP profile

Declaration

public CicpProfile? CicpProfile { get; set; }

Property Value

Type	Description
CicpProfile

ExifProfile

Gets or sets the Exif profile.

Declaration

public ExifProfile? ExifProfile { get; set; }

Property Value

Type	Description
ExifProfile

IccProfile

Gets or sets the ICC profile.

Declaration

public IccProfile? IccProfile { get; set; }

Property Value

Type	Description
IccProfile

IptcProfile

Gets or sets the iptc profile.

Declaration

public IptcProfile? IptcProfile { get; set; }

Property Value

Type	Description
IptcProfile

XmpProfile

Gets or sets the XMP profile.

Declaration

public XmpProfile? XmpProfile { get; set; }

Property Value

Type	Description
XmpProfile

Methods

DeepClone()

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

Declaration

public ImageFrameMetadata DeepClone()

Returns

Type	Description
ImageFrameMetadata	The 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.

Declaration

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

Parameters

Type	Name	Description
IImageFormat<TFormatMetadata, TFormatFrameMetadata>	key	The key of the value to get.

Returns

Type	Description
TFormatFrameMetadata	The TFormatFrameMetadata.

Type Parameters

Name	Description
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.

Declaration

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

Parameters

Type	Name	Description
IImageFormat<TFormatMetadata, TFormatFrameMetadata>	key	The key of the value to get.
TFormatFrameMetadata	metadata	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

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

Type Parameters

Name	Description
TFormatMetadata	The type of format metadata.
TFormatFrameMetadata	The type of format frame metadata.

Implements

IDeepCloneable<T>

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?)