Inlay Function Reference 0.2.2

Reference

Function Catalog

Version: 0.2.2

Generated: 2026-03-13T03:02:43+00:00

Total functions: 24

Core4
Media3
S3 Storage11
Video2
Licensing3
Update1

Core

4 functions

Inlay_GET_BOOTTIME

Returns a boot-time runtime anchor (Unix seconds).

CoremacOS onlyReturns JSON

Signature

Inlay_GET_BOOTTIME

Parameters

This function takes no parameters.

Returns

JSON string

Returns runtime timing values used as a monotonic anchor for workflow logic.

Example

Get runtime anchor

Inlay_GET_BOOTTIME

Use Cases

Track elapsed runtime between scripted steps without relying on wall-clock drift.

Notes / Caveats

macOS only. Calls from unsupported platforms return an error response.

Related Functions

Inlay_GET_PUBLIC_IP

Returns the public WAN (NAT/masqueraded) IP address seen from the internet using a public IP lookup service.

CoreReturns JSON

Signature

Inlay_GET_PUBLIC_IP

Parameters

This function takes no parameters.

Returns

JSON string

Returns WAN IP lookup results in JSON (success/error state plus IP value when available).

Example

Check WAN IP

Inlay_GET_PUBLIC_IP

Use Cases

Display current WAN egress IP in diagnostic/admin layouts.

Notes / Caveats

Network availability and endpoint latency directly affect response time.

Related Functions

Inlay_CONNECTION_DIAG

Runs a real-time connection diagnostic window (20 probes) for a host/IP and graphs latency.

CoreOpens UIReturns JSON

Signature

Inlay_CONNECTION_DIAG ( IPorDNS )

Parameters

IPorDNSRequired
Hostname or IP address to probe for latency diagnostics.

Returns

Status JSON

Opens a native diagnostic window and returns immediate status JSON for launch state.

Example

Test latency to host

Inlay_CONNECTION_DIAG ( "db.filemaker.example.com" )

Use Cases

Diagnose high-latency conditions when users report slow FileMaker UX.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_CUSTOM_FUNCTION

Calls a license-bound custom function.

CoreReturns JSON

Signature

Inlay_CUSTOM_FUNCTION ( CustomFunctionName ; PayloadJson )

Parameters

CustomFunctionNameRequired
Entitled custom function name tied to the current licensee.
PayloadJsonRequired
JSON payload string containing inputs required by the custom workflow.

Returns

JSON string

Returns custom-function execution status JSON tied to license entitlements.

Example

Run entitled custom workflow

Inlay_CUSTOM_FUNCTION ( "color_grade_pipeline" ; "{""jobId"":""J-2049"",""preset"":""broadcast""}" )

Use Cases

Execute customer-specific extensions tied to paid entitlement scope.

Notes / Caveats

Custom functions are license-bound; calls without matching entitlement are denied.

Related Functions

Media

3 functions

Inlay_INSPECT_CONTAINER

Inspects a FileMaker container field and returns JSON describing what is inside (stream type, size, and image dimensions when available).

MediaReturns JSON

Signature

Inlay_INSPECT_CONTAINER ( container )

Parameters

containerRequired
FileMaker container field value to inspect.

Returns

JSON string

Returns JSON metadata about the container stream and media properties when available.

Example

Inspect a container field

Inlay_INSPECT_CONTAINER ( Media::AssetContainer )

Use Cases

Branch workflow logic based on detected stream/media type inside a container field.
Validate upload candidates before pushing them to object storage.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_LOAD_IMAGE

Loads a local JPEG, PNG, GIF, BMP, or PDF from an absolute path and returns it as a FileMaker container.

MediaReturns Container

Signature

Inlay_LOAD_IMAGE ( path )

Parameters

pathRequired
Absolute file path to a local image or PDF file that should be loaded into a container.

Returns

FileMaker container

Returns container data for the local file when the path is valid.

Example

Load local poster image

Inlay_LOAD_IMAGE ( "/Users/shared/posters/titlecard.png" )

Use Cases

Inject a local poster, graphic, or PDF into a FileMaker container field.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_LOAD_REMOTE_IMAGE

Downloads an image from URL and returns it as a FileMaker container.

MediaReturns Container

Signature

Inlay_LOAD_REMOTE_IMAGE ( url { ; TTLHours { ; encryptKey { ; date } } } )

Parameters

urlRequired
HTTPS URL to a remote image source.
TTLHoursOptional
Cache freshness duration in hours.
encryptKeyOptional
Passphrase used for local cache encryption.
dateOptional
Optional argument. Omit to use the default behavior.

Returns

FileMaker container

Returns container data for the downloaded image; cache settings can affect fetch behavior.

Example

Load CDN image with cache controls

Inlay_LOAD_REMOTE_IMAGE ( "https://cdn.example.com/posters/titlecard.jpg" ; 24 ; "poster-cache-key" ; "2026-03-10" )

Use Cases

Render externally hosted poster/key-art in FileMaker without manual download steps.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
TTL/SourceDate settings control cache freshness and when objects are re-fetched.

Related Functions

S3 Storage

11 functions

Inlay_S3_GET

Downloads a private object from S3-compatible storage (AWS S3, Spaces, etc.) and returns a FileMaker container.

S3 StorageReturns Container

Signature

Mode A: ConfigKey

Inlay_S3_GET ( ConfigKey ; SourcePath )

Mode B: Direct credentials

Inlay_S3_GET ( Domain ; Region ; AccessKey ; SecretKey ; Bucket ; SourcePath { ; TTLHours { ; EncryptKey { ; SourceDate } } } )

Parameters

ConfigKeyRequired
Name of an S3 profile previously registered with Inlay_S3_SET_CONFIG. Use this mode for cleaner scripts.
SourcePathRequired
Object key path in the bucket (for example, posters/episode1/keyart.jpg).
DomainRequired
S3-compatible endpoint host when using direct-credentials mode.
RegionRequired
Region identifier used for signing requests (for example, us-east-1).
AccessKeyRequired
Access key ID for direct-credentials mode.
SecretKeyRequired
Secret access key for direct-credentials mode.
BucketRequired
Bucket name that contains SourcePath.
TTLHoursOptional
Cache freshness window in hours for local reuse.
EncryptKeyOptional
Passphrase used to encrypt/decrypt cached object bytes on disk.
SourceDateOptional
Source modified date used to force refresh when object changes.

Returns

FileMaker container

Returns the object body as container data after access and caching checks.

Example

Mode A: ConfigKey

Inlay_S3_GET ( "prod-media" ; "posters/episode1/keyart.jpg" )

Mode B: Direct credentials

Inlay_S3_GET ( "nyc3.digitaloceanspaces.com" ; "us-east-1" ; "DO_ACCESS_KEY" ; "DO_SECRET_KEY" ; "inlay-assets" ; "posters/episode1/keyart.jpg" ; 24 ; "media-cache-key" ; "2026-03-10" )

Use Cases

Show private S3 media directly inside container fields.
Pull source assets from storage before handing off to transcode workflows.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
TTL/SourceDate settings control cache freshness and when objects are re-fetched.

Related Functions

Inlay_S3_PUT_CONTAINER

Uploads a FileMaker container to S3 using ConfigKey.

S3 StorageActionReturns JSON

Signature

Inlay_S3_PUT_CONTAINER ( ConfigKey ; DestinationFolder ; SourceContainer { ; Metadata { ; DestinationFilename { ; TTLHoursOverride { ; EncryptKeyOverride } } } } )

Parameters

ConfigKeyRequired
Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.
DestinationFolderRequired
Bucket folder/prefix where uploaded files should be stored.
SourceContainerRequired
FileMaker container field value to upload.
MetadataOptional
JSON object string of metadata key/value pairs to write with the object.
DestinationFilenameOptional
Optional target object filename to override the source name.
TTLHoursOverrideOptional
Cache freshness duration in hours.
EncryptKeyOverrideOptional
Passphrase used for local cache encryption.

Returns

JSON string

Returns JSON upload status/details for the container transfer operation.

Example

Upload container with metadata

Inlay_S3_PUT_CONTAINER ( "prod-media" ; "exports/invoices" ; Invoices::PdfContainer ; "{""customerId"":""C-10042"",""docType"":""invoice""}" ; "invoice-10042.pdf" )

Use Cases

Upload generated PDFs from container fields into archive buckets.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
Transfer behavior can be synchronous or async based on WaitForCompletion profile settings.

Related Functions

Inlay_S3_PUT_FILE

Opens a native file picker and uploads the selected file to S3 using ConfigKey.

S3 StorageOpens UIActionReturns JSON

Signature

Inlay_S3_PUT_FILE ( ConfigKey ; DestinationFolder { ; Metadata { ; DestinationFilename { ; TTLHoursOverride { ; EncryptKeyOverride } } } } )

Parameters

ConfigKeyRequired
Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.
DestinationFolderRequired
Bucket folder/prefix where uploaded files should be stored.
MetadataOptional
JSON object string of metadata key/value pairs to write with the object.
DestinationFilenameOptional
Optional target object filename to override the source name.
TTLHoursOverrideOptional
Cache freshness duration in hours.
EncryptKeyOverrideOptional
Passphrase used for local cache encryption.

Returns

Action status JSON

Opens a native file picker and returns JSON describing upload status/result.

Example

Pick local file and upload

Inlay_S3_PUT_FILE ( "prod-media" ; "uploads/source-footage" ; "{""project"":""episode1""}" ; "fishing.mov" )

Use Cases

Let operators pick a local file and push it to the active project bucket.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
Transfer behavior can be synchronous or async based on WaitForCompletion profile settings.

Related Functions

Inlay_S3_VERIFY

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

S3 StorageReturns JSON

Signature

Mode A: ConfigKey

Inlay_S3_VERIFY ( ConfigKey ; SourcePath )

Mode B: Direct credentials

Inlay_S3_VERIFY ( Domain ; Region ; AccessKey ; SecretKey ; Bucket ; SourcePath )

Parameters

ConfigKeyRequired
Named profile key from Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key path to validate before downloading or rendering.
DomainRequired
Endpoint host for direct-credentials mode.
RegionRequired
Region used for request signing.
AccessKeyRequired
Access key ID for direct-credentials mode.
SecretKeyRequired
Secret access key for direct-credentials mode.
BucketRequired
Bucket containing SourcePath.

Returns

JSON string

Returns object-availability JSON without downloading the full object body.

Example

Mode A: ConfigKey

Inlay_S3_VERIFY ( "prod-media" ; "trailers/episode1/final.mp4" )

Mode B: Direct credentials

Inlay_S3_VERIFY ( "s3.amazonaws.com" ; "us-east-1" ; "AWS_ACCESS_KEY" ; "AWS_SECRET_KEY" ; "media-prod" ; "trailers/episode1/final.mp4" )

Use Cases

Confirm object availability before attempting download/render.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
Verification functions validate object state and do not return container file bodies.

Related Functions

Inlay_S3_VERIFY_HASH

Validates an S3 object against an expected SHA-256 value and returns whether it matches, plus object size and returned hash details.

S3 StorageReturns JSON

Signature

Inlay_S3_VERIFY_HASH ( ConfigKey ; SourcePath ; ExpectedHash )

Parameters

ConfigKeyRequired
Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key path inside your bucket (for example, posters/episode1/keyart.jpg).
ExpectedHashRequired
Expected SHA-256 hash (hex) used for integrity comparison.

Returns

JSON string

Returns JSON hash verification results for the requested object.

Example

Verify object hash

Inlay_S3_VERIFY_HASH ( "prod-media" ; "trailers/episode1/final.mp4" ; "6de9d78f2f95ef7fda94d11fbe9f0e7d5e9a5e7f0be42a8a43a0b8b14f76d6db" )

Use Cases

Validate media integrity after upload or external processing.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
Verification functions validate object state and do not return container file bodies.

Related Functions

Inlay_S3_GET_THUMBNAIL

Returns a preview image (<OriginalFileName>_Preview.png) from the same S3 folder as a FileMaker container.

S3 StorageReturns Container

Signature

Mode A: ConfigKey

Inlay_S3_GET_THUMBNAIL ( ConfigKey ; SourcePath )

Mode B: Direct credentials

Inlay_S3_GET_THUMBNAIL ( Domain ; Region ; AccessKey ; SecretKey ; Bucket ; SourcePath { ; TTLHours { ; EncryptKey { ; SourceDate } } } )

Parameters

ConfigKeyRequired
Named profile key from Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key whose sidecar preview image should be returned.
DomainRequired
Endpoint host for direct-credentials mode.
RegionRequired
Region used for request signing.
AccessKeyRequired
Access key ID for direct-credentials mode.
SecretKeyRequired
Secret access key for direct-credentials mode.
BucketRequired
Bucket containing SourcePath and preview assets.
TTLHoursOptional
Cache freshness in hours for the generated/loaded preview image.
EncryptKeyOptional
Passphrase for encrypted thumbnail cache entries.
SourceDateOptional
Modified-date hint used for cache refresh decisions.

Returns

FileMaker container

Returns a PNG preview container for the target object.

Example

Get preview image via ConfigKey

Inlay_S3_GET_THUMBNAIL ( "prod-media" ; "trailers/episode1/final.mp4" )

Use Cases

Display preview images for larger media objects without loading full files.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
TTL/SourceDate settings control cache freshness and when objects are re-fetched.

Related Functions

Inlay_S3_SET_CONFIG

Saves reusable S3 connection settings under ConfigKey for the current FileMaker session.

S3 StorageReturns JSON

Signature

Mode A: ConfigKey

Inlay_S3_SET_CONFIG ( ConfigKey ; Domain ; Region ; AccessKey ; SecretKey ; Bucket { ; DefaultTTLHours { ; DefaultEncryptKey { ; WaitForCompletion(1|0) } } } )

Mode B: Clear config key

Inlay_S3_SET_CONFIG ( ConfigKey )

Parameters

ConfigKeyRequired
Profile key you reference in later S3 functions (for example, prod-media).
DomainRequired
S3 endpoint host used when creating/updating the profile.
RegionRequired
S3 region for request signing (for example, us-east-1).
AccessKeyRequired
Access key ID for this profile.
SecretKeyRequired
Secret access key for this profile.
BucketRequired
Default bucket for this profile.
TTLHoursOptional
Default cache duration in hours for reads that support caching.
EncryptKeyOptional
Default passphrase for encrypted local cache storage.
WaitForCompletionOptional
Set 1 for synchronous transfers or 0 for async background behavior where supported.

Returns

JSON string

Returns JSON confirming config save/update/clear operations for the active session.

Example

Create/update profile

Inlay_S3_SET_CONFIG ( "prod-media" ; "nyc3.digitaloceanspaces.com" ; "us-east-1" ; "DO_ACCESS_KEY" ; "DO_SECRET_KEY" ; "inlay-assets" ; 24 ; "media-cache-key" ; 1 )

Clear existing profile

Inlay_S3_SET_CONFIG ( "prod-media" )

Use Cases

Notes / Caveats

Network availability and endpoint latency directly affect response time.

Related Functions

Inlay_S3_GET_METADATA

Returns S3 object metadata and content length for the target object path.

S3 StorageReturns JSON

Signature

Mode A: ConfigKey

Inlay_S3_GET_METADATA ( ConfigKey ; SourcePath )

Mode B: Direct credentials

Inlay_S3_GET_METADATA ( Domain ; Region ; AccessKey ; SecretKey ; Bucket ; SourcePath )

Parameters

ConfigKeyRequired
Named profile key from Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key to inspect for metadata and object length.
DomainRequired
Endpoint host for direct-credentials mode.
RegionRequired
Region used for request signing.
AccessKeyRequired
Access key ID for direct-credentials mode.
SecretKeyRequired
Secret access key for direct-credentials mode.
BucketRequired
Bucket containing SourcePath.

Returns

JSON string

Returns metadata JSON (including object size and metadata fields) for the target object.

Example

Read object metadata

Inlay_S3_GET_METADATA ( "prod-media" ; "posters/episode1/keyart.jpg" )

Use Cases

Read content length and metadata before deciding processing paths.

Notes / Caveats

Network availability and endpoint latency directly affect response time.

Related Functions

Inlay_S3_DOWNLOAD_TO_PATH

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

S3 StorageReturns JSON

Signature

Inlay_S3_DOWNLOAD_TO_PATH ( ConfigKey ; SourcePath { ; DestinationPath } )

Parameters

ConfigKeyRequired
Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key path inside your bucket (for example, posters/episode1/keyart.jpg).
DestinationPathOptional
Absolute local destination path for downloaded output.

Returns

JSON string

Returns JSON describing the local download result path, object details, and transfer status.

Example

Download object to local path

Inlay_S3_DOWNLOAD_TO_PATH ( "prod-media" ; "posters/episode1/keyart.jpg" ; "/Users/shared/Downloads/episode1-keyart.jpg" )

Use Cases

Download source assets to local disk for external tools or manual review.

Notes / Caveats

Network availability and endpoint latency directly affect response time.

Related Functions

Inlay_S3_OPEN_FILE_AT_PATH

Opens a local file in the OS default application.

S3 StorageActionOpens UIReturns JSON

Signature

Inlay_S3_OPEN_FILE_AT_PATH ( Path )

Parameters

PathRequired
Absolute local file path (or FileMaker-style file path) to open in the default OS app.

Returns

Action status JSON

Attempts to open a local file in the OS default app and returns success/error JSON.

Example

Open local file

Inlay_S3_OPEN_FILE_AT_PATH ( "/Users/shared/Downloads/episode1-keyart.jpg" )

Use Cases

Open a downloaded file in the default desktop app from a script step.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_S3_RENDER_MEDIA_HTML

Returns media access URL(s) and an embeddable HTML viewer (video/image/pdf/audio/file) for an S3 object.

S3 StorageReturns JSON

Signature

Mode A: ConfigKey

Inlay_S3_RENDER_MEDIA_HTML ( ConfigKey ; SourcePath { ; UrlTtlSeconds { ; ViewerMode } } )

Mode B: Direct credentials

Inlay_S3_RENDER_MEDIA_HTML ( Domain ; Region ; AccessKey ; SecretKey ; Bucket ; SourcePath { ; UrlTtlSeconds { ; ViewerMode } } )

Parameters

ConfigKeyRequired
Named profile key from Inlay_S3_SET_CONFIG.
SourcePathRequired
Object key for the media asset to render.
DomainRequired
Endpoint host for direct-credentials mode.
RegionRequired
Region used for request signing.
AccessKeyRequired
Access key ID for direct-credentials mode.
SecretKeyRequired
Secret access key for direct-credentials mode.
BucketRequired
Bucket containing SourcePath.
UrlTtlSecondsOptional
Signed URL lifetime in seconds for embedded playback.
ViewerModeOptional
Viewer override: auto, video, image, pdf, audio, or file.

Returns

JSON string

Returns JSON payload containing signed media URL details and embeddable viewer HTML.

Example

Render embeddable media viewer

Inlay_S3_RENDER_MEDIA_HTML ( "prod-media" ; "trailers/episode1/final.mp4" ; 900 ; "video" )

Use Cases

Embed signed media playback HTML in web viewers/container web areas.

Notes / Caveats

Network availability and endpoint latency directly affect response time.
Signed media URLs expire; regenerate HTML when viewer sessions outlive URL TTL.

Related Functions

Video

2 functions

Inlay_VIDEO_METADATA

Analyzes a media file and returns JSON metadata (format, streams, duration, frame information).

VideomacOS onlyReturns JSON

Signature

Inlay_VIDEO_METADATA ( InputPath { ; FFprobePath } )

Parameters

InputPathRequired
Absolute local source media path.
FFprobePathOptional
Absolute path override for ffprobe executable.

Returns

JSON string

Returns JSON media-analysis details such as streams, duration, and format metadata.

Example

Analyze media file

Inlay_VIDEO_METADATA ( "/Users/shared/media/fishing.mov" )

Use Cases

Read stream/frame metadata before choosing transcode presets.

Notes / Caveats

macOS only. Calls from unsupported platforms return an error response.

Related Functions

Inlay_TRANSCODE

Starts a media transcode job and returns immediately with {"ok":true,"status":"started","job_id":"..."}.

VideomacOS onlyOpens UIReturns JSON

Signature

Inlay_TRANSCODE ( InputPath ; OutputPath { ; FFmpegArgsJson { ; JobId { ; FFmpegPath { ; FFprobePath { ; TapeName { ; MasterClipName } } } } } } )

Parameters

InputPathRequired
Absolute local source path to the media file that should be transcoded.
OutputPathRequired
Absolute local output path for the transcoded file.

FFmpegArgsJsonOptional

JSON array string of FFmpeg argument tokens.

[
    "-vf",
    "scale=1920:1080",
    "-c:v",
    "libx264",
    "-b:v",
    "5M",
    "-c:a",
    "aac",
    "-b:a",
    "192k"
]

JobIdOptional
Custom identifier used to correlate progress and logs.
FFmpegPathOptional
Custom absolute path to ffmpeg binary if not using default tool location.
FFprobePathOptional
Custom absolute path to ffprobe binary for metadata probing.
TapeNameOptional
Optional metadata tag written into transcode output where supported.
MasterClipNameOptional
Optional clip-name metadata written into output where supported.

Returns

Status JSON

Opens a native progress window and returns immediate status JSON for the started job.

Example

Transcode with custom FFmpeg args

Inlay_TRANSCODE ( "/Users/shared/media/fishing.mov" ; "/Users/shared/media/fishing-h264.mp4" ; "[""-vf"",""scale=1920:1080"",""-c:v"",""libx264"",""-b:v"",""5M"",""-c:a"",""aac"",""-b:a"",""192k""]" ; "job-fishing-1080" )

Use Cases

Launch transcode jobs with deterministic codec/bitrate settings from FileMaker scripts.

Notes / Caveats

macOS only. Calls from unsupported platforms return an error response.
The function starts work and returns status JSON immediately while processing continues in a native window.
This call returns before long-running operations fully finish.

Related Functions

Licensing

3 functions

Inlay_REGISTER_LICENSE

Activates this plugin installation using a valid Inlay license key (offline key or platform key).

LicensingReturns JSON

Signature

Inlay_REGISTER_LICENSE ( key )

Parameters

keyRequired
Inlay license key string from your issued license artifact.

Returns

JSON string

Returns activation success/error JSON for the provided license key.

Example

Activate plugin license

Inlay_REGISTER_LICENSE ( "eyJwcm9kdWN0IjoiaW5sYXkiLC4uLn0.Dd7A..." )

Use Cases

Activate a newly provisioned workstation during onboarding.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_LICENSE_STATUS

Returns current license status as JSON.

LicensingReturns JSON

Signature

Inlay_LICENSE_STATUS

Parameters

This function takes no parameters.

Returns

JSON string

Returns the current local license state JSON for script gating and UI display.

Example

Read current license state

Inlay_LICENSE_STATUS

Use Cases

Gate premium script paths to licensed installations only.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Inlay_PLATFORM_DEACTIVATE

Releases the current machine from platform activation and clears local activation state for this installation.

LicensingReturns JSON

Signature

Inlay_PLATFORM_DEACTIVATE

Parameters

This function takes no parameters.

Returns

JSON string

Returns JSON confirming local activation state was released/cleared.

Example

Release current machine activation

Inlay_PLATFORM_DEACTIVATE

Use Cases

Release a seat before machine replacement or VM rotation.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Update

1 function

Inlay_SELF_UPDATE

Checks for plugin updates (release, beta, nightly) and returns available versions for macOS/Windows.

UpdateReturns JSON

Signature

Inlay_SELF_UPDATE ( { ; CurrentVersionOverride { ; Channel { ; RequestedVersion { ; Platform { ; ApplyUpdate(YES|NO) } } } } } )

Parameters

CurrentVersionOverrideOptional
Current plugin version override for update comparison.
ChannelOptional
Update channel to query (release, beta, nightly).
RequestedVersionOptional
Target plugin version to evaluate or install.
PlatformOptional
Platform override used when evaluating update availability.
ApplyUpdateOptional
Set YES to apply the selected update; NO performs check-only behavior.

Returns

JSON string

Returns JSON describing available versions and update/apply status.

Example

Check latest stable release

Inlay_SELF_UPDATE

Check beta channel

Inlay_SELF_UPDATE ( "0.2.3" ; "beta" ; "0.2.4-beta.1" ; "macos" ; "NO" )