Skip to content

API Reference

Celfie Lock edited this page Jan 7, 2026 · 1 revision

API Reference

encode()

Hide a message inside an image using LSB steganography with encryption.

encode(input_path, output_path, message, **options)

Parameters

Parameter Type Default Description
input_path str required Path to source image
output_path str required Path for protected image
message str required Secret message to hide
link str "" Optional URL to embed
watermark_text str None Visible watermark text
watermark_position str "bottom-left" Watermark placement
watermark_opacity float 0.8 Transparency (0.0-1.0)
watermark_size int 20 Font size

Returns

bool - True if successful


decode()

Extract a hidden message from a protected image.

message = decode(image_path)

Returns

str - The hidden message, or None if not found


Watermark Positions

Position Description
top-left Upper left corner
top-right Upper right corner
bottom-left Lower left corner
bottom-right Lower right corner
center Center of image

Clone this wiki locally