scanbotsdk
    Preparing search index...

    Class ExtractedImage

    An image extracted from a multipage image.

    Since the instance of the class contains objects backed by native resources (e.g. images) and implements AsyncDisposable it's highly recommended to use the await using syntax when an instance is created or is received from an API:

    await using instance = await getExtractedImageFromAnApi();
    

    Alternatively, one can explicitly call release method to release the native resources or use autorelease convenience function. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

    Implements

    • AsyncDisposable
    Index

    Constructors

    Properties

    Methods

    Constructors

    • Parameters

      • source: DeepPartial<ExtractedImage> = {}

      Returns ExtractedImage

    Properties

    image: ImageRef

    The extracted image.

    metadata: ExtractedImageMetadata | null

    Metadata of the extracted image.

    Methods

    • Returns Promise<void>

    • Returns Promise<void>