Image Angel Client SDK

This package is a server-side SDK for using the Image Angel watermarking service. For more information on Image Angel and to obtain an API key, see http://imageangel.co.uk

Installation

npm install image-angel

Usage

Setup:

import { Client } from 'image-angel';
const client = new Client();

Lambda API

To generate an overlay using the Lambda API:

import { Client } from 'image-angel';
const client = new Client();

const overlayResult = await client.generateOverlay({
    clientId: 'client_1',            // Required: Client ID
    wm_id: '1A2B3C4D',              // Required: Overlay ID as hex string (up to 8 chars)
    width: 1920,                    // Optional: Width (default 1920)
    height: 1080,                   // Optional: Height (default 1080)
    format: "yuv"                  // Optional: Format (default "yuv")
});

The wm_id (overlay ID) must be a valid hexadecimal string (up to 8 characters, case-insensitive), representing a value between 0 and 4294967295 (FFFFFFFF in hex). The method validates this and will throw an error if the value is outside this range or not a valid hex string.

License

This package is distributed under the Apache License, Version 2.0, see LICENSE for more information.