Class Reader

Implements

ReaderInterface

Index

Constructors

Methods

activeLabel getActive getHandle isEmbedded json remoteUrl resourceToAsset fromAsset fromManifestDataAndAsset

Constructors

constructor

new Reader(reader: unknown): Reader
Parameters
- reader: unknown
Returns Reader

Methods

activeLabel

activeLabel(): string | undefined
Returns string | undefined

getActive

getActive(): Manifest | undefined
Returns Manifest | undefined

getHandle

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

Returns unknown
Implementation of ReaderInterface.getHandle

isEmbedded

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

Returns boolean
Implementation of ReaderInterface.isEmbedded

json

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

Returns ManifestStore
Implementation of ReaderInterface.json

remoteUrl

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

Returns string
Implementation of ReaderInterface.remoteUrl

resourceToAsset

resourceToAsset(uri: string, asset: DestinationAsset): Promise<ResourceAsset>
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

`Static`fromAsset

fromAsset(
asset: SourceAsset,
settingsOrContext?: Context | C2paSettings | null,
): Promise<Reader | null>
Parameters
- asset: SourceAsset
- OptionalsettingsOrContext: Context | C2paSettings | null
  A Context, or (@deprecated) a raw C2paSettings string/object. Passing a raw C2paSettings value is deprecated and will be removed in a future version. null is treated the same as undefined.
Returns Promise<Reader | null>

`Static`fromManifestDataAndAsset

fromManifestDataAndAsset(
    manifestData: Buffer,
    asset: SourceAsset,
    settingsOrContext?: Context | C2paSettings | null,
): Promise<Reader>
Parameters
- manifestData: Buffer
- asset: SourceAsset
- OptionalsettingsOrContext: Context | C2paSettings | null
  A Context, or (@deprecated) a raw C2paSettings string/object. Passing a raw C2paSettings value is deprecated and will be removed in a future version. null is treated the same as undefined.
Returns Promise<Reader>