@contentauth/c2pa-js
    Preparing search index...

    Interface ManifestDefinition

    Use a ManifestDefinition to define a manifest and to build a ManifestStore. A manifest is a collection of ingredients and assertions used to define a claim that can be signed and embedded into a file.

    interface ManifestDefinition {
        assertions?: AssertionDefinition[];
        claim_generator_info?: ClaimGeneratorInfo[];
        claim_version?: number | null;
        format?: string;
        hash_alg?: string | null;
        ingredients?: Ingredient[];
        instance_id?: string;
        label?: string | null;
        metadata?: AssertionMetadata[] | null;
        redactions?: string[] | null;
        thumbnail?: ResourceRef | null;
        title?: string | null;
        vendor?: string | null;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    assertions? claim_generator_info? claim_version? format? hash_alg? ingredients? instance_id? label? metadata? redactions? thumbnail? title? vendor?

    Properties

    assertions?: AssertionDefinition[]

    A list of assertions

    claim_generator_info?: ClaimGeneratorInfo[]

    Claim Generator Info is always required with an entry

    claim_version?: number | null

    The version of the claim. Defaults to 2.

    format?: string

    The format of the source file as a MIME type.

    hash_alg?: string | null

    Hash algorithm used for asset hashing (DataHash, BmffHash) and assertion hashing in the claim. Defaults to "sha256" when not set.

    Valid values: "sha256", "sha384", "sha512".

    This sets the claim-level alg field and is the default used by [Builder::update_hash_from_stream]. It can be overridden on individual hard binding assertions (e.g. a pre-constructed DataHash) by setting the assertion's own alg field before adding it to the builder.

    Named hash_alg (rather than alg) to avoid collision with the signer's signature algorithm, which uses the same key in some combined JSON configurations.

    ingredients?: Ingredient[]

    A List of ingredients

    instance_id?: string

    Instance ID from xmpMM:InstanceID in XMP metadata.

    label?: string | null

    Allows you to pre-define the manifest label, which must be unique. Not intended for general use. If not set, it will be assigned automatically.

    metadata?: AssertionMetadata[] | null

    Optional manifest metadata. This will be deprecated in the future; not recommended to use.

    redactions?: string[] | null

    A list of redactions - URIs to redacted assertions.

    thumbnail?: ResourceRef | null

    An optional ResourceRef to a thumbnail image that represents the asset that was signed. Must be available when the manifest is signed.

    title?: string | null

    A human-readable title, generally source filename.

    vendor?: string | null

    Optional prefix added to the generated Manifest Label This is typically a reverse domain name.

    Settings

    Member Visibility

    On This Page

    Properties