diff --git a/docs/embeddable-api.md b/docs/embeddable-api.md index f7bc01a..572af2f 100644 --- a/docs/embeddable-api.md +++ b/docs/embeddable-api.md @@ -189,9 +189,21 @@ These methods perform the signing workflow: placeholder creation, hashing, and s | `Builder::update_hash_from_stream(format, stream)` | Reads the asset stream and computes the hard-binding hash. Automatically selects the appropriate path based on format: `BmffHash` for BMFF (skips manifest box), `BoxHash` for chunk-based formats (creates assertion if needed), or `DataHash` (skips exclusion ranges). Takes a `std::istream&`. | | `Builder::sign_embeddable(format)` | Signs the manifest and returns bytes ready to embed. For placeholder workflows, it pads the output to match the placeholder size for in-place patching. For BoxHash workflows, the output is the actual signed manifest size (not padded), suitable for appending as a new chunk. | +### Deprecated methods + +The c2pa-rs 0.92.0 removes C FFI functions behind some `Builder` methods. These methods will be removed when c2pa-c moves to c2pa-rs 0.92.0. + +| Deprecated method | Replacement | +|-------------------|-------------| +| `data_hashed_placeholder(reserved_size, format)` | `needs_placeholder(format)`, then `placeholder(format)`. The reserve size comes from the signer on the Context. | +| `sign_data_hashed_embeddable(signer, data_hash, format, asset)` | `set_data_hash_exclusions(exclusions)`, `update_hash_from_stream(format, stream)`, then `sign_embeddable(format)`. The signer comes from the Context. | +| `format_embeddable(format, data)` | `sign_embeddable(format)`, which returns bytes already formatted for `format`. | + +For the full replacement flow, see [Using the DataHash placeholder](#using-the-datahash-placeholder). + ## Using the DataHash placeholder -Use this workflow for JPEG, PNG, and other non-BMFF formats. +Use this workflow for JPEG, PNG, and other non-BMFF formats.