---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertOptions.md
description: >-
  The options bag carried by a [`ConvertRequest`](https://adk.nht.io/api/@nhtio/adk/batteries/media/contracts/interfaces/ConvertRequest) — one typed, augmentable
  interface merging every documented convention.
---

# Interface: ConvertOptions

Defined in: [src/batteries/media/contracts.ts:245](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/contracts.ts#L245)

The options bag carried by a [ConvertRequest](ConvertRequest.md) — one typed, augmentable interface
merging every documented convention.

## Remarks

Consumers add their own keys via declaration merging against this module:

```ts
declare module "@nhtio/adk/batteries/media/contracts" {
  interface ConvertOptions {
    watermark?: { text: string };
  }
}
```

Typo'd keys become excess-property compile errors at literal call sites; the runtime stays
open — engines must ignore keys they don't understand (multi-hop conversion forwards one
bag to every hop). The namespace is flat and globally merged, so BYO keys should be named
to avoid collisions (prefix by engine where ambiguous).

## Extends

* [`OcrConvertOptions`](OcrConvertOptions.md).[`AsrConvertOptions`](AsrConvertOptions.md).[`ImagesConvertOptions`](ImagesConvertOptions.md)

## Properties

| Property                                                       | Type                    | Description                                                                                                                                                                    | Inherited from                                                                                        | Defined in                                                                                                                                                                                              |
| -------------------------------------------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `augmentedWatermark?` | { `text`: `string`; } | -                                                                                                                                                                              | -                                                                                                     | [tests/unit/batteries/media/convert\_options\_augmentation.cross.spec.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts#L9) |
| `augmentedWatermark.text`                                      | `string`                | -                                                                                                                                                                              | -                                                                                                     | [tests/unit/batteries/media/convert\_options\_augmentation.cross.spec.ts:9](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts#L9) |
|  `format?`                         | `string`                | Preferred output encoding token (`jpg`, `png`, …). An extractor that can emit it natively should; outputs in other encodings are re-encoded downstream by the requesting step. | [`ImagesConvertOptions`](ImagesConvertOptions.md).[`format`](ImagesConvertOptions.md#property-format) | [src/batteries/media/contracts.ts:222](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/contracts.ts#L222)                                                                       |
|  `lang?`                             | `string`                | Source-language hint (BCP-47-ish).                                                                                                                                             | [`AsrConvertOptions`](AsrConvertOptions.md).[`lang`](AsrConvertOptions.md#property-lang)              | [src/batteries/media/contracts.ts:211](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/contracts.ts#L211)                                                                       |
|  `languages?`                   | readonly `string`\[]     | Recognition language hints (e.g. `['eng','deu']`).                                                                                                                             | [`OcrConvertOptions`](OcrConvertOptions.md).[`languages`](OcrConvertOptions.md#property-languages)    | [src/batteries/media/contracts.ts:205](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/contracts.ts#L205)                                                                       |
|  `translate?`                   | `boolean`               | Translate the transcription to English.                                                                                                                                        | [`AsrConvertOptions`](AsrConvertOptions.md).[`translate`](AsrConvertOptions.md#property-translate)    | [src/batteries/media/contracts.ts:213](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/contracts.ts#L213)                                                                       |