@contentauth/c2pa-node / BuilderInterface
Interface: BuilderInterface
Defined in: types.d.ts:175
Methods
addAssertion()
addAssertion(
label,assertion,assertionKind?):void
Defined in: types.d.ts:192
Add CBOR assertion to the builder
Parameters
label
string
The label of the assertion
assertion
unknown
The assertion, should be a string if the type is JSON, otherwise a JS Object
assertionKind?
The type of assertion
Returns
void
addIngredient()
addIngredient(
ingredientJson,ingredient):Promise<void>
Defined in: types.d.ts:209
Add an ingredient from a buffer or file
Parameters
ingredientJson
string
The JSON representation of the ingredient
ingredient
The source and format of the ingredient
Returns
Promise<void>
addResource()
addResource(
uri,resource):Promise<void>
Defined in: types.d.ts:202
Add a resource from a buffer or file
Parameters
uri
string
The URI of the resource
resource
The source and format of the resource
Returns
Promise<void>
getManifestDefinition()
getManifestDefinition():
Manifest
Defined in: types.d.ts:277
Getter for the builder’s manifest definition
Returns
Manifest
The manifest definition
setNoEmbed()
setNoEmbed(
noEmbed):void
Defined in: types.d.ts:180
Set the no embed flag of the manifest
Parameters
noEmbed
boolean
The no embed flag of the manifest
Returns
void
setRemoteUrl()
setRemoteUrl(
url):void
Defined in: types.d.ts:185
Set the remote URL of the manifest
Parameters
url
string
The remote URL of the manifest
Returns
void
sign()
sign(
signer,input,output):Buffer
Defined in: types.d.ts:224
Sign an asset from a buffer or file
Parameters
signer
The local signer to use
input
output
Returns
Buffer
the bytes of the c2pa_manifest that was embedded
signAsync()
signAsync(
callbackSigner,input,output):Promise<Buffer<ArrayBufferLike>>
Defined in: types.d.ts:254
Sign an asset from a buffer or file asynchronously, using a CallbackSigner
Parameters
callbackSigner
The CallbackSigner
CallbackSignerInterface |
IdentityAssertionSignerInterface |
input
output
Returns
Promise<Buffer<ArrayBufferLike>>
the bytes of the c2pa_manifest that was embedded
signConfigAsync()
signConfigAsync(
callback,signerConfig,input,output):Promise<Buffer<ArrayBufferLike>>
Defined in: types.d.ts:239
Sign an asset from a buffer or file asynchronously, using a callback and not passing a private key
Parameters
callback
(data) => Promise<Buffer<ArrayBufferLike>>
The callback function to sign the asset
signerConfig
The configuration for the signer
input
output
Returns
Promise<Buffer<ArrayBufferLike>>
the bytes of the c2pa_manifest that was embedded
signFile()
signFile(
signer,filePath,output):Buffer
Defined in: types.d.ts:267
Embed a signed manifest into a stream using the LocalSigner
Parameters
signer
The local signer to use
filePath
string
output
Returns
Buffer
the bytes of the c2pa_manifest that was embedded
toArchive()
toArchive(
asset):Promise<void>
Defined in: types.d.ts:215
Convert the Builder into a archive formatted buffer or file
Parameters
asset
The file or buffer for the archive
Returns
Promise<void>
updateManifestProperty()
updateManifestProperty(
property,value):void
Defined in: types.d.ts:283
Update a string property of the manifest
Parameters
property
string
value
string |
ClaimVersion |
Returns
void
The manifest definition