Interface ReaderInterface

interface ReaderInterface {
    getHandle(): unknown;
    isEmbedded(): boolean;
    json(): ManifestStore;
    remoteUrl(): string;
    resourceToAsset(
        uri: string,
        output: DestinationAsset,
    ): Promise<ResourceAsset>;
}

Implemented by

Reader

Index

Methods

getHandle isEmbedded json remoteUrl resourceToAsset

Methods

getHandle

getHandle(): unknown
Get the internal handle for use with Neon bindings

Returns unknown
- Defined in c2pa-node/js-src/types.d.ts:382

isEmbedded

isEmbedded(): boolean
Returns true if the the reader was created from an embedded manifest

Returns boolean
- Defined in c2pa-node/js-src/types.d.ts:365

json

json(): ManifestStore
Get the JSON representation of the manifest

Returns ManifestStore
- Defined in c2pa-node/js-src/types.d.ts:355

remoteUrl

remoteUrl(): string
Get the remote url of the manifest if this reader obtained the manifest remotely

Returns string
- Defined in c2pa-node/js-src/types.d.ts:360

resourceToAsset

resourceToAsset(uri: string, output: DestinationAsset): Promise<ResourceAsset>
Write a resource to a buffer or file
Parameters
- uri: string
  The URI of the resource
- output: DestinationAsset
  The destination asset (file or buffer)
Returns Promise<ResourceAsset>
When output is a file, returns the number of bytes written. When output is a buffer, returns an object with the buffer and bytes written.
- Defined in c2pa-node/js-src/types.d.ts:374