HeifImageHandleGetAuxiliaryImageIds Method

Gets a list of the auxiliary image ids.

Definition

Namespace: LibHeifSharp
Assembly: LibHeifSharp (in LibHeifSharp.dll) Version: 3.2.0
C#
public IReadOnlyList<HeifItemId> GetAuxiliaryImageIds()

Return Value

IReadOnlyListHeifItemId
A list of the auxiliary image ids.

Remarks

The alpha and/or depth images are omitted from this list.

LibHeif will include the alpha image (if present) when you call Decode(HeifColorspace, HeifChroma, HeifDecodingOptions) with the HeifChroma parameter set to one of the InterleavedRgba values.

To read the depth images use GetDepthImageIds to get a list of the depth image item ids and GetDepthImage(HeifItemId) to convert the item id to a HeifImageHandle.

This method is supported starting with LibHeif version 1.11.0, it will return an empty collection on older versions.

Exceptions

HeifExceptionA LibHeif error occurred.
ObjectDisposedExceptionThe object has been disposed.

See Also