Interface: ConvertOptions

Defined in: src/batteries/media/contracts.ts:245

The options bag carried by a ConvertRequest — one typed, augmentable interface merging every documented convention.

Remarks

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

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.AsrConvertOptions.ImagesConvertOptions

Properties

Property	Type	Description	Inherited from	Defined in
augmentedWatermark?	{ text: string; }	-	-	tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts:9
augmentedWatermark.text	string	-	-	tests/unit/batteries/media/convert_options_augmentation.cross.spec.ts:9
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.format	src/batteries/media/contracts.ts:222
lang?	string	Source-language hint (BCP-47-ish).	AsrConvertOptions.lang	src/batteries/media/contracts.ts:211
languages?	readonly string[]	Recognition language hints (e.g. ['eng','deu']).	OcrConvertOptions.languages	src/batteries/media/contracts.ts:205
translate?	boolean	Translate the transcription to English.	AsrConvertOptions.translate	src/batteries/media/contracts.ts:213