Marker
Defined in: src/web/index.ts:182
Public image-marking API shared by native and Web targets.
Metro selects the native TurboModule implementation on iOS and Android. React Native Web and standard browser bundlers select this SSR-safe Canvas 2D implementation, which only touches DOM globals when a method is called.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Marker():
Marker
Returns
Section titled “Returns”Marker
Methods
Section titled “Methods”createRecipe()
Section titled “createRecipe()”
staticcreateRecipe<ResultOptions>(options,resultOptions?):WatermarkRecipe<ResultOptionsextendsWatermarkBlobRecipeResultOptions?Blob:MarkerResult>
Defined in: src/web/index.ts:338
Save ordered layers and output settings for reuse across one or many images.
Type Parameters
Section titled “Type Parameters”ResultOptions
Section titled “ResultOptions”ResultOptions extends WatermarkRecipeResultOptions | undefined = undefined
Parameters
Section titled “Parameters”options
Section titled “options”resultOptions?
Section titled “resultOptions?”ResultOptions
Returns
Section titled “Returns”WatermarkRecipe<ResultOptions extends WatermarkBlobRecipeResultOptions ? Blob : MarkerResult>
detectInvisible()
Section titled “detectInvisible()”
staticdetectInvisible(options,control?):Promise<InvisibleWatermarkDetectionResult>
Defined in: src/web/index.ts:277
Detect and authenticate an invisible locator in an image without writing a file.
Parameters
Section titled “Parameters”options
Section titled “options”DetectInvisibleWatermarkOptions
control?
Section titled “control?”Returns
Section titled “Returns”Promise<InvisibleWatermarkDetectionResult>
detectInvisibleMany()
Section titled “detectInvisibleMany()”
staticdetectInvisibleMany(inputs,options?):Promise<WatermarkBatchResult<InvisibleWatermarkDetectionResult>[]>
Defined in: src/web/index.ts:224
Detect authenticated locators in many images while preserving input order.
Parameters
Section titled “Parameters”inputs
Section titled “inputs”readonly DetectInvisibleWatermarkOptions[]
options?
Section titled “options?”WatermarkBatchOptions<InvisibleWatermarkDetectionResult>
Returns
Section titled “Returns”Promise<WatermarkBatchResult<InvisibleWatermarkDetectionResult>[]>
embedInvisible()
Section titled “embedInvisible()”
staticembedInvisible(options,control?):Promise<MarkerResult>
Defined in: src/web/index.ts:246
Embed a short, authenticated locator into the final image pixels.
This Beta API supports distribution tracing. It is not DRM, encryption, or proof that the image was never edited.
Parameters
Section titled “Parameters”options
Section titled “options”EmbedInvisibleWatermarkOptions
control?
Section titled “control?”Returns
Section titled “Returns”Promise<MarkerResult>
embedInvisibleMany()
Section titled “embedInvisibleMany()”
staticembedInvisibleMany(inputs,options?):Promise<WatermarkBatchResult<MarkerResult>[]>
Defined in: src/web/index.ts:207
Embed authenticated locators into many images while preserving input order.
Parameters
Section titled “Parameters”inputs
Section titled “inputs”readonly EmbedInvisibleWatermarkOptions[]
options?
Section titled “options?”WatermarkBatchOptions<MarkerResult>
Returns
Section titled “Returns”Promise<WatermarkBatchResult<MarkerResult>[]>
embedInvisibleWithCredentials()
Section titled “embedInvisibleWithCredentials()”
staticembedInvisibleWithCredentials(options,control?):Promise<EmbedInvisibleWithCredentialsResult>
Defined in: src/web/index.ts:189
Embed a locator first, then ask the supplied adapter to sign the result.
Parameters
Section titled “Parameters”options
Section titled “options”EmbedInvisibleWithCredentialsOptions
control?
Section titled “control?”Returns
Section titled “Returns”Promise<EmbedInvisibleWithCredentialsResult>
getImageInfo()
Section titled “getImageInfo()”
staticgetImageInfo(source):Promise<MarkerImageInfo>
Defined in: src/web/index.ts:184
Read display dimensions, encoded dimensions, format, and orientation.
Parameters
Section titled “Parameters”source
Section titled “source”any
Returns
Section titled “Returns”Promise<MarkerImageInfo>
importRecipe()
Section titled “importRecipe()”
staticimportRecipe<ResultOptions>(document,resultOptions?):WatermarkRecipe<ResultOptionsextendsWatermarkBlobRecipeResultOptions?Blob:MarkerResult>
Defined in: src/web/index.ts:388
Import a persisted Recipe v1/v2 document, migrating v1 to v2 first.
Type Parameters
Section titled “Type Parameters”ResultOptions
Section titled “ResultOptions”ResultOptions extends WatermarkRecipeResultOptions | undefined = undefined
Parameters
Section titled “Parameters”document
Section titled “document”resultOptions?
Section titled “resultOptions?”ResultOptions
Returns
Section titled “Returns”WatermarkRecipe<ResultOptions extends WatermarkBlobRecipeResultOptions ? Blob : MarkerResult>
mark()
Section titled “mark()”
staticmark(options,control?):Promise<MarkerResult>
Defined in: src/web/index.ts:498
Render ordered mixed text and image watermark layers.
Parameters
Section titled “Parameters”options
Section titled “options”control?
Section titled “control?”Returns
Section titled “Returns”Promise<MarkerResult>
markImage()
Section titled “markImage()”
staticmarkImage(options,control?):Promise<MarkerResult>
Defined in: src/web/index.ts:467
Render one or more image watermark layers.
Parameters
Section titled “Parameters”options
Section titled “options”control?
Section titled “control?”Returns
Section titled “Returns”Promise<MarkerResult>
markText()
Section titled “markText()”
staticmarkText(options,control?):Promise<MarkerResult>
Defined in: src/web/index.ts:438
Render one or more text watermark layers.
Parameters
Section titled “Parameters”options
Section titled “options”control?
Section titled “control?”Returns
Section titled “Returns”Promise<MarkerResult>
verifyContentCredentials()
Section titled “verifyContentCredentials()”
staticverifyContentCredentials(options):Promise<ContentCredentialsVerificationResult>
Defined in: src/web/index.ts:200
Verify Content Credentials through an application-supplied adapter.
Parameters
Section titled “Parameters”options
Section titled “options”VerifyContentCredentialsOptions
Returns
Section titled “Returns”Promise<ContentCredentialsVerificationResult>