@contentauth/c2pa-node


@contentauth/c2pa-node / Reader

Class: Reader

Defined in: Reader.ts:26

Implements

Constructors

Constructor

new Reader(reader): Reader

Defined in: Reader.ts:27

Parameters

reader

unknown

Returns

Reader

Methods

activeLabel()

activeLabel(): undefined | string

Defined in: Reader.ts:65

Returns

undefined | string


getActive()

getActive(): undefined | Manifest

Defined in: Reader.ts:70

Returns

undefined | Manifest


getHandle()

getHandle(): unknown

Defined in: Reader.ts:81

Get the internal handle for use with Neon bindings

Returns

unknown

Implementation of

ReaderInterface.getHandle


isEmbedded()

isEmbedded(): boolean

Defined in: Reader.ts:37

Returns true if the the reader was created from an embedded manifest

Returns

boolean

Implementation of

ReaderInterface.isEmbedded


json()

json(): ManifestStore

Defined in: Reader.ts:29

Get the JSON representation of the manifest

Returns

ManifestStore

Implementation of

ReaderInterface.json


remoteUrl()

remoteUrl(): string

Defined in: Reader.ts:33

Get the remote url of the manifest if this reader obtained the manifest remotely

Returns

string

Implementation of

ReaderInterface.remoteUrl


resourceToAsset()

resourceToAsset(uri, asset): Promise<ResourceAsset>

Defined in: Reader.ts:41

Write a resource to a buffer or file

Parameters

uri

string

The URI of the resource

asset

DestinationAsset

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.

Implementation of

ReaderInterface.resourceToAsset


fromAsset()

static fromAsset(asset, settings?): Promise<null | Reader>

Defined in: Reader.ts:45

Parameters

asset

SourceAsset

settings?

C2paSettings

Returns

Promise<null | Reader>


fromManifestDataAndAsset()

static fromManifestDataAndAsset(manifestData, asset, settings?): Promise<Reader>

Defined in: Reader.ts:52

Parameters

manifestData

Buffer

asset

SourceAsset

settings?

C2paSettings

Returns

Promise<Reader>