HeifImageHandleGetAuxiliaryImageIds Method

Gets a list of the auxiliary image ids.

Namespace: LibHeifSharp
Assembly: LibHeifSharp (in LibHeifSharp.dll) Version: 2.3.0

Syntax

public IReadOnlyList<HeifItemId> GetAuxiliaryImageIds()

Public Function GetAuxiliaryImageIds As IReadOnlyList(Of HeifItemId)

public:
IReadOnlyList<HeifItemId>^ GetAuxiliaryImageIds()

member GetAuxiliaryImageIds : unit -> IReadOnlyList<HeifItemId>

IReadOnlyListHeifItemId
A list of the auxiliary image ids.

Exceptions

Exception	Condition
HeifException	A LibHeif error occurred.
ObjectDisposedException	The object has been disposed.

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.