Inlay Function Reference

Core 12 functions

Diagnostics, environment checks, and platform utilities.

GET_BOOTTIME macOS only

Returns wall-clock uptime in milliseconds since boot as a plain number.

GET_PUBLIC_IP

Returns the public WAN IP address this machine presents to the internet.

CONNECTION_DIAG

Opens a real-time connection diagnostic window that probes a host or IP and graphs latency.

CUSTOM_FUNCTION

Calls a license-bound custom function gated by your licensee entitlement.

OPEN_LOG

Opens the current Inlay plugin log file in the default system application.

VERIFY_CODESIGN macOS only

Verifies code-sign trust of a binary or app bundle using codesign and spctl.

CORE_RUN_PING

Starts an asynchronous ping against a host and returns right away with a job label you poll later.

CORE_GET_PING_RESULT

Polls a ping job started with Inlay_CORE_RUN_PING and returns its current state and captured output.

CORE_RUN_TRACE

Starts an asynchronous traceroute against a host and returns right away with a job label you poll later.

CORE_GET_TRACE

Polls a traceroute job started with Inlay_CORE_RUN_TRACE and returns its current state and captured output.

CORE_LIST_JOBS

Lists every ping and traceroute job currently held in the plugin's in-memory state.

PATH_CONVERT New

Takes a single file path in any recognized style and returns a JSON envelope expressing that path in every equivalent form, so you can hand the right form to FileMaker, a container field, the shell, or another plugin without massaging strings by hand.

Media 4 functions

Container inspection, image loading, and WebViewer drop zones.

INSPECT_CONTAINER

Returns JSON describing the contents of a FileMaker container field.

LOAD_IMAGE

Loads a local file from disk and returns it as a FileMaker container value.

LOAD_REMOTE_IMAGE

Downloads a file from a URL and returns it as a FileMaker container, with optional local caching.

RENDER_DROPZONE_HTML Updated

Renders an HTML drop zone for a WebViewer.

S3 Storage 16 functions

Moving media and documents between FileMaker and private S3 storage.

S3_GET

Downloads a private object from S3-compatible storage and returns it as a FileMaker container.

S3_PUT_CONTAINER

Uploads a FileMaker container to S3.

S3_PUT_FILE

Opens a native file picker and uploads the selected file to S3-compatible storage.

S3_VERIFY

Checks whether an S3 object is reachable with the provided credentials and returns basic object details without downloading the body.

S3_VERIFY_HASH

Validates an S3 object against an expected SHA-256 value and reports whether they match.

S3_GET_THUMBNAIL

Returns a PNG preview image for an S3 object as a FileMaker container.

S3_SET_CONFIG

Saves reusable S3 connection settings under a named key for the current FileMaker session.

S3_GET_METADATA

Returns the metadata and content length of an S3 object without downloading its body.

S3_DOWNLOAD_TO_PATH

Downloads an S3 object to local disk with a cancelable progress window.

S3_OPEN_FILE_AT_PATH

Opens a local file in the operating system's default application for that file type.

S3_RENDER_MEDIA_HTML

Returns a signed media URL and an embeddable HTML viewer for an S3 object, ready to drop into a WebViewer.

S3_MOUNT

Mounts or unmounts an S3 bucket as a native cloud-storage drive.

S3_MOVE

Moves an S3 object or folder prefix to another S3 location, deleting the source only after the destination is confirmed.

S3_COPY

Copies files between the local filesystem and S3, in either direction, with a multi-file progress window.

S3_PRECACHE

Warms the local S3 disk cache in the background so later reads return instantly.

S3_RENDER_MEDIA_EDITOR_HTML

Renders an interactive media review and editing surface for an S3 object inside a WebViewer: a Plyr video player with drop-frame-aware SMPTE timecode, timecode-anchored annotations (Annotations tab), and an Edit tab of in/out clips.

Finder & Explorer 6 functions

Finder Quick Action and Windows Explorer context menu integration.

FINDER_INSTALL macOS only

Installs a Finder Quick Action into ~/Library/Services/ so the user can right-click any file in Finder and send it to FileMaker.

FINDER_GETPATH macOS only

Pops the latest "Send to FileMaker" payload from the Finder inbox.

ExplorerContext_INSTALL Windows only

Registers an Explorer context-menu entry so right-clicking any file shows "Send to FileMaker".

ExplorerContext_GETPATH Windows only

Pops the latest "Send to FileMaker" payload from the Explorer inbox.

FINDER_UNINSTALL macOS only

Removes the installed Finder Quick Action from ~/Library/Services/ and flushes the Services cache so the entry disappears from Finder immediately.

ExplorerContext_UNINSTALL Windows only

Removes the "Send to <noun>" shortcut from the user's SendTo folder and cleans up any legacy registry entry.

Excel Export 1 function

Native .xlsx generation, including password protected workbooks.

EXCEL_EXPORT

Writes a multi-sheet xlsx workbook from a JSON spec.

SMPTE Timecode 1 function

SMPTE timecode conversion and arithmetic.

TIMECODE

One dispatcher for the SMPTE timecode operations, selected by an Action.

Video / Audio 4 functions

FFmpeg based metadata, transcoding, and tooling checks.

VIDEO_METADATA

Analyzes a media file with FFprobe and returns its metadata as JSON.

TRANSCODE

Starts a non-blocking FFmpeg transcode job and returns immediately.

INSTALL_FFMPEG

Downloads and installs FFmpeg, FFprobe, and FFplay into Inlay's managed tools directory.

CHECK_FFMPEG

Reports whether FFmpeg, FFprobe, and FFplay are installed and where.

Transcription 8 functions

Whisper transcription of audio and video files.

INSTALL_WHISPER macOS only

Installs the whisper-cli binary (and on macOS the ggml-metal.metallib shader) into the Inlay helper data dir.

WHISPER_MODEL_INSTALL macOS only

Downloads a GGML whisper.cpp model into the Inlay helper data dir.

TRANSCRIBE macOS only

Starts an offline speech-to-text job using whisper.cpp.

TRANSCRIBE_CANCEL macOS only

Requests cancellation of an in-flight Inlay_TRANSCRIBE job.

TRANSCRIBE_STATUS macOS only

Returns the current state of an Inlay_TRANSCRIBE job.

TRANSCRIBE_LIST_JOBS macOS only

Diagnostic listing of every Inlay_TRANSCRIBE job currently tracked in this FileMaker session.

TRANSCRIBE_FORGET macOS only

Drops a single transcribe job from the plugin's in-memory registry.

TRANSCRIBE_CLEAR_ALL macOS only

Drops every transcribe job from the plugin's in-memory registry, unlinks every on-disk status file, and cancels every pending onCompleteScript watcher.

Security & TOTP 9 functions

RFC 6238 one time codes, verification, and secret wrapping.

TOTP_GENERATE_SECRET

Generates a random base32 TOTP shared secret for enrolling a user in two-factor authentication.

TOTP_PROVISIONING_URI

Builds an otpauth:// provisioning URI that authenticator apps can import.

TOTP_QR

Renders an otpauth:// URI as a scannable QR code, as a PNG container or an HTML img tag.

TOTP_NOW

Computes the current TOTP code for a base32 secret at the system clock.

TOTP_VERIFY

Checks a user-entered TOTP code against a secret and, on success, mints a session token.

TOTP_WRAP

Encrypts a TOTP secret so it can be stored at rest instead of the raw base32 value.

TOTP_UNWRAP

Decrypts a blob produced by Inlay_TOTP_WRAP back into the original base32 secret.

TOTP_BACKUP_GENERATE

Generates a batch of one-time recovery codes for users who lose access to their authenticator.

TOTP_SESSION_VERIFY

Checks whether a session token from Inlay_TOTP_VERIFY is still valid and refreshes its idle timer.

Licensing 4 functions

License registration, status, and activation control.

REGISTER_LICENSE

Activates this plugin installation with an Inlay license key.

LICENSE_STATUS

Reports the current license and activation state as JSON.

DEACTIVATE

Fully deactivates this plugin installation, locally and online.

PLATFORM_DEACTIVATE

Deprecated alias for Inlay_DEACTIVATE, kept for one release cycle.

Update 1 function

Plugin self update.

SELF_UPDATE

Checks the update manifest and optionally stages and installs a plugin update.