Type Alias: BmffHashExclusion

type BmffHashExclusion = object;

Defined in: bmff/BmffHashExclusion.ts:34

Identifies a BMFF box, or byte ranges of a box, to exclude from the C2PA content hash (c2pa.hash.bmff.v3).

The fields follow the exclusions-map of C2PA section 18.6.2. A box matches the exclusion when its path matches xpath and every present constraint holds.

Properties

data?

readonly data?: readonly BmffHashConstraint[];

Defined in: bmff/BmffHashExclusion.ts:40

The box matches only if its bytes at each offset equal value.

---

exact?

readonly exact?: boolean;

Defined in: bmff/BmffHashExclusion.ts:48

If false, the box matches when its flags have at least the bits of flags. Defaults to true.

---

flags?

readonly flags?: 
  | Uint8Array
  | readonly number[];

Defined in: bmff/BmffHashExclusion.ts:46

The box matches only if it is a FullBox with these 3 flag bytes.

---

length?

readonly length?: number;

Defined in: bmff/BmffHashExclusion.ts:38

The box matches only if its length, header included, equals this value.

---

subset?

readonly subset?: readonly BmffHashSubset[];

Defined in: bmff/BmffHashExclusion.ts:42

Excludes only these byte ranges of the box instead of the whole box.

---

version?

readonly version?: number;

Defined in: bmff/BmffHashExclusion.ts:44

The box matches only if it is a FullBox with this version.

---

xpath

readonly xpath: string;

Defined in: bmff/BmffHashExclusion.ts:36

Path of the box from the root, such as /emsg or /moov/trak[2]/udta.