Signature

Inlay_GET_BOOTTIME ( { CacheBuster } )

Parameters

• CacheBusterOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

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

Signature

Inlay_GET_PUBLIC_IP

Parameters

This function takes no parameters.

Returns

Script Pattern

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

Signature

Inlay_CONNECTION_DIAG ( IPorDNS )

Parameters

• IPorDNSRequired

  Hostname or IP address to probe for latency diagnostics.

Returns

Script Pattern

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

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

Script Pattern

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

Signature

Inlay_DEACTIVATE

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_DEACTIVATE

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_OPEN_LOG

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_OPEN_LOG

Use Cases

• Open the rolling Inlay log quickly during support or QA sessions.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_VERIFY_CODESIGN ( { PathOrHost } )

Parameters

• PathOrHostOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

Inlay_VERIFY_CODESIGN

Inlay_VERIFY_CODESIGN ( "/Users/shared/file.ext" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

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

Related Functions

Signature

Inlay_CHECK_FFMPEG

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_CHECK_FFMPEG

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_EXCEL_EXPORT ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "outputPath" ; "<path>" ; JSONString ] ;
    [ "password" ; "<optional>" ; JSONString ] ;
    [ "sheets" ; "<sheets-json>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_EXCEL_EXPORT ( "{""ok"":true}" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_CORE_RUN_PING ( Label ; IPorDNS )

Parameters

• LabelRequired

  Required argument for this call pattern.

• IPorDNSRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_CORE_RUN_PING ( "example" ; "db.filemaker.example.com" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

• This call returns before long-running operations fully finish.

Related Functions

Signature

Inlay_CORE_GET_PING_RESULT ( Label )

Parameters

• LabelRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_CORE_GET_PING_RESULT ( "example" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_CORE_RUN_TRACE ( Label ; IPorDNS )

Parameters

• LabelRequired

  Required argument for this call pattern.

• IPorDNSRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_CORE_RUN_TRACE ( "example" ; "db.filemaker.example.com" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

• This call returns before long-running operations fully finish.

Related Functions

Signature

Inlay_CORE_GET_TRACE ( Label )

Parameters

• LabelRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_CORE_GET_TRACE ( "example" )

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_CORE_LIST_JOBS

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_CORE_LIST_JOBS

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_INSPECT_CONTAINER ( Container )

Parameters

• containerRequired

  FileMaker container field value to inspect.

Returns

Script Pattern

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

Signature

Inlay_LOAD_IMAGE ( Path )

Parameters

• PathRequired

  Required argument for this call pattern.

Returns

Script Pattern

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

Signature

Inlay_LOAD_REMOTE_IMAGE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "url" ; "<image-url>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

• JSONBooleanOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

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

Signature

Inlay_S3_GET ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ]
  ) )

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

Script Pattern

Set Variable [ $asset ;
    Inlay_S3_GET (
        "prod-media" ;
        "posters/episode1/keyart.jpg"
    )
]

Set Variable [ $asset ;
    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

Signature

Inlay_S3_PUT_CONTAINER ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "destinationFolder" ; "<folder>" ; JSONString ]
  ) )

Parameters

• Optional

  ConfigKey: saved config name (from Inlay_S3_SET_CONFIG), or an inline JSON object with domain, region, accessKey, secretKey, bucket.

• Optional

  DestinationFolder: S3 key prefix (e.g. "media/2026" or "" for root).

• Optional

  SourceContainer: the FileMaker container value to upload.

• MetadataOptional

  JSON object of S3 object metadata.

• DestinationFilenameOptional

  override the container's filename.

• TTLHoursOverrideOptional

  cache TTL override.

• EncryptKeyOverrideOptional

  cache encryption key override.

Returns

Script Pattern

Set Variable [ $upload ;
    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

Signature

Inlay_S3_PUT_FILE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "destinationFolder" ; "<folder>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

• JSONBooleanOptional

  Optional argument. Omit to use the default behavior.

• configOptional

  Optional argument. Omit to use the default behavior.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

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

Signature

Inlay_S3_VERIFY ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ]
  ) )

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

Script Pattern

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

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

Signature

Inlay_S3_VERIFY_HASH ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ] ;
    [ "expectedHash" ; "<sha256-hex>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

• JSONBooleanOptional

  Optional argument. Omit to use the default behavior.

• configOptional

  Optional argument. Omit to use the default behavior.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

• pathOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

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

Signature

Inlay_S3_GET_THUMBNAIL ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ]
  ) )

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

Script Pattern

Set Variable [ $preview ;
    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

Signature

Inlay_S3_SET_CONFIG ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "configKey" ; "<config-key>" ; JSONString ] ;
    [ "domain" ; "<s3-domain>" ; JSONString ] ;
    [ "region" ; "<region>" ; JSONString ] ;
    [ "accessKey" ; "<access-key>" ; JSONString ] ;
    [ "secretKey" ; "<secret-key>" ; JSONString ] ;
    [ "bucket" ; "<bucket>" ; JSONString ]
  ) )

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

Script Pattern

Set Variable [ $config ;
    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
    )
]

Set Variable [ $config ;
    Inlay_S3_SET_CONFIG ( "prod-media" )
]

Use Cases

• Register per-environment profiles (prod, staging) once per session.

Notes / Caveats

• Network availability and endpoint latency directly affect response time.

Related Functions

Signature

Inlay_S3_GET_METADATA ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ]
  ) )

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

Script Pattern

Set Variable [ $meta ;
    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

Signature

Inlay_S3_DOWNLOAD_TO_PATH ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "sourcePath" ; "<s3-source-path>" ; JSONString ] ;
    [ "destinationPath" ; "<local-destination>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

Set Variable [ $download ;
    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

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

Script Pattern

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

Signature

Inlay_S3_RENDER_MEDIA_HTML ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "path" ; "<object-path>" ; JSONString ]
  ) )

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

Script Pattern

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

Signature

Inlay_S3_MOUNT ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "action" ; "<register|unregister>" ; JSONString ] ;
    [ "readOnly" ; False ; JSONBoolean ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

Inlay_S3_MOUNT ( "{""ok"":true}" )

Inlay_S3_MOUNT ( "{""ok"":true}" ; "example" ; "example" )

Use Cases

• Use this function to automate S3-backed FileMaker workflows with repeatable scripts.

Notes / Caveats

• Network availability and endpoint latency directly affect response time.

Related Functions

Signature

Inlay_S3_MOVE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "sourceConfig" ; "<source-config-key>" ; JSONString ] ;
    [ "sourcePath" ; "<source-path>" ; JSONString ] ;
    [ "destinationConfig" ; "<destination-config-key>" ; JSONString ] ;
    [ "destinationPath" ; "<destination-path>" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• _inlayOptional

  Optional argument. Omit to use the default behavior.

• TrueOptional

  Optional argument. Omit to use the default behavior.

• JSONBooleanOptional

  Optional argument. Omit to use the default behavior.

• sourceConfigOptional

  Optional argument. Omit to use the default behavior.

• sourceOptional

  Optional argument. Omit to use the default behavior.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

Returns

Script Pattern

Inlay_S3_MOVE ( "{""ok"":true}" )

Inlay_S3_MOVE ( "{""ok"":true}" ; "example" ; "example" ; "{""ok"":true}" ; "example" ; "example" ; "{""ok"":true}" )

Use Cases

• Use this function to automate S3-backed FileMaker workflows with repeatable scripts.

Notes / Caveats

• Network availability and endpoint latency directly affect response time.

Related Functions

Signature

Inlay_S3_COPY ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "sourcePath" ; "<source-path>" ; JSONString ] ;
    [ "destinationPath" ; "<destination-path>" ; JSONString ]
  ) )

Parameters

• ConfigKeyRequired

  Saved S3 profile key created with Inlay_S3_SET_CONFIG.

• SrcPathRequired

  Source path. Use a local filesystem path for uploads or an S3 object/prefix for downloads.

• DstPathRequired

  Destination path. Use an S3 key/prefix for uploads or a local filesystem path for downloads.

• ConflictOptional

  Conflict strategy when the destination already exists: overwrite, ignore, etag, size, md5, or sha256.

Returns

Script Pattern

Set Variable [ $copy ;
    Inlay_S3_COPY (
        "prod-media" ;
        "/Users/shared/Deliverables/interview.mov" ;
        "projects/1234/interview.mov" ;
        "overwrite"
    )
]

Set Variable [ $copy ;
    Inlay_S3_COPY (
        "prod-media" ;
        "projects/1234/interview.mov" ;
        "/Users/shared/Downloads/interview.mov" ;
        "md5"
    )
]

Use Cases

• Move assets between local disk and S3 with a native progress window for operators.
• Upload deliverables or pull review files down to a workstation without custom helper scripts.

Notes / Caveats

• Network availability and endpoint latency directly affect response time.
• This function opens a native progress window because local-to-S3 and S3-to-local copies can run longer than a typical script step.
• Conflict modes that rely on hashes may read existing files before deciding whether to copy.

Related Functions

Signature

Inlay_S3_PRECACHE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "config" ; "<config-key>" ; JSONString ] ;
    [ "paths" ; List (
        "<object-path-1>" ;
        "<object-path-2>"
    ) ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_S3_PRECACHE ( "{""ok"":true}" )

Use Cases

• Use this function to automate S3-backed FileMaker workflows with repeatable scripts.

Notes / Caveats

• Network availability and endpoint latency directly affect response time.
• This call returns before long-running operations fully finish.

Related Functions

Signature

Inlay_TIMECODE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "action" ; "<action-name>" ; JSONString ] ;
    [ "arg1" ; "<primary-input>" ; JSONString ]
  ) )

Parameters

• actionRequired

  Operation token. Choose one of the actions below.

  Conversions

  normalize

  Re-express a frame count or timecode as a valid SMPTE string at the same rate.

  convert

  Convert a timecode or frame count to a target type (smpte, frames, seconds, feet+frames).

  rebase

  Change the frame rate of a timecode, adjusting its value to preserve runtime.

  Parsing

  parse

  Parse a timecode string and return its components as JSON.

  parts

  Return HH, MM, SS, FF components of a timecode as a JSON object.

  isValid

  Return 1 if the timecode is structurally valid for the given rate, 0 otherwise.

  Rate info

  rateInfo

  Return metadata about a rate token (numerator, denominator, drop-frame flag).

  ratePlayback

  Return the playback speed of a rate as a decimal (e.g. 29.97).

  rateTimebase

  Return the timebase of a rate (e.g. 30 for 29.97df).

  rateNtsc

  Return 1 if the rate is an NTSC variant, 0 otherwise.

  Arithmetic

  add

  Add two timecodes or a timecode and a frame offset.

  subtract

  Subtract one timecode from another.

  compare

  Compare two timecodes; returns -1, 0, or 1.

  scale

  Multiply a timecode by a numeric factor.

  mod

  Return the remainder after dividing one timecode by another.

  negate

  Negate a timecode (flip its sign).

  abs

  Return the absolute value of a timecode.

• arg1Required

  Primary input for the selected action. Usually a timecode string, numeric value, or rate token depending on action.

• arg2Optional

  Second action-specific argument. Commonly rate, source type, comparison value, or numeric factor.

• arg3Optional

  Third action-specific argument. Commonly fromRate, toType, or tcB depending on action.

• arg4Optional

  Fourth action-specific argument. Commonly toType or rate depending on action.

• arg5Optional

  Fifth action-specific argument. Used by convert for optional toRate.

• optionsJSONOptional

  Optional JSON settings. convert currently supports filmFormat (35mm4, 35mm3, 35mm2, 16mm) and mode (rebase or runtime).

  {"filmFormat":"35mm4","mode":"runtime"}

Returns

Script Pattern

Set Variable [ $tc ;
    Inlay_TIMECODE ( "normalize" ; "1:2:3:4" ; "23.98" )
]

Set Variable [ $frames ;
    Inlay_TIMECODE (
        "convert" ;
        "01:00:00:00" ;
        "timecode" ;
        "24" ;
        "frames"
    )
]

Set Variable [ $feet ;
    Inlay_TIMECODE (
        "convert" ;
        "864" ;
        "frames" ;
        "24" ;
        "feet" ;
        "" ;
        "{""filmFormat"":""35mm4""}"
    )
]

Set Variable [ $rate ;
    Inlay_TIMECODE ( "rateInfo" ; "29.97df" )
]

Set Variable [ $sum ;
    Inlay_TIMECODE (
        "add" ;
        "00:59:30;00" ;
        "00:00:45;00" ;
        "29.97df"
    )
]

Use Cases

• Normalize operator-entered timecode before storing it in canonical SMPTE format.
• Convert between timecode, frame counts, runtime seconds, Premiere ticks, and film feet+frames inside FileMaker scripts.
• Perform frame-accurate arithmetic and comparison at explicit SMPTE rates, including drop-frame workflows.

Notes / Caveats

• All actions return JSON. Success responses include ok: true and the selected action; validation failures return ok: false with a message.
• 29.97 and 59.94 default to non-drop-frame. Use 29.97df or 59.94df explicitly when you need drop-frame semantics.
• optionsJSON is only meaningful for actions that support optional behavior, primarily convert.

Related Functions

No direct related functions listed.

Signature

Inlay_VIDEO_METADATA ( InputPath { ; FFprobePath } )

Parameters

• InputPathRequired

  Absolute local source media path.

• FFprobePathOptional

  Absolute path override for ffprobe executable.

Returns

Script Pattern

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

Use Cases

• Read stream/frame metadata before choosing transcode presets.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TRANSCODE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "inputPath" ; "<input-path>" ; JSONString ] ;
    [ "outputPath" ; "<output-path>" ; JSONString ]
  ) )

Parameters

• InputPathSimple, required

  Absolute path to the source media file. Accepts HFS (Macintosh HD:…), filemac:/…, file:/…, filewin:/…, or POSIX path.

• OutputPathSimple, required

  Absolute path for the output file, typically ending in .mp4. Same path formats as InputPath.

• FFmpegArgsJsonSimple, optional

  JSON array of FFmpeg CLI tokens that override the default H.264 settings, e.g. ["-crf","18"]. Omit to use the built-in H.264 MP4 preset.

• AdvancedJobJsonAdvanced, replaces all above

  Pass a JSON object as the only argument to take full control: multiple outputs, filter_complex graphs, custom stream mapping. Required fields: inputs (array of {path}), outputs (array of {path, args}). When used, InputPath and OutputPath are not needed.

Returns

Script Pattern

Set Variable [ $job ;
    Inlay_TRANSCODE (
        "/Users/shared/media/source.mov" ;
        "/Users/shared/media/output.mp4"
    )
]

Set Variable [ $job ;
    Inlay_TRANSCODE (
        "{
  ""global_args"": [""-y""],
  ""inputs"": [
    { ""path"": ""/Volumes/Media/source.mov"" }
  ],
  ""filter_complex"": ""[0:v]split=3[vhires][vproxy_src][vpost_src];[vproxy_src]scale=960:540[vproxy];[vpost_src]thumbnail=300[vposter]"",
  ""outputs"": [
    {
      ""path"": ""/Volumes/Media/output_1080p.mp4"",
      ""args"": [""-map"",""[vhires]"",""-map"",""0:a?"",""-c:v"",""libx264"",""-preset"",""medium"",""-crf"",""20"",""-pix_fmt"",""yuv420p"",""-movflags"",""+faststart"",""-c:a"",""aac"",""-b:a"",""192k""]
    },
    {
      ""path"": ""/Volumes/Media/output_proxy.mp4"",
      ""args"": [""-map"",""[vproxy]"",""-map"",""0:a?"",""-c:v"",""libx264"",""-preset"",""fast"",""-crf"",""28"",""-c:a"",""aac"",""-b:a"",""96k""]
    },
    {
      ""path"": ""/Volumes/Media/poster.png"",
      ""args"": [""-map"",""[vposter]"",""-frames:v"",""1""]
    }
  ]
}"
    )
]

Use Cases

• Transcode any source video to browser-ready H.264 MP4 with just two arguments, no FFmpeg knowledge required.
• Produce a hi-res delivery file, a smaller proxy, and a poster image all in one pass using the advanced JSON mode.
• Automate post-production workflows: trigger a transcode from a FileMaker script and poll the result file until done.

Notes / Caveats

• Returns immediately; transcoding happens in the background with a native progress window. Poll the result_path file in a script loop to detect completion.
• The progress window can be cancelled by the user. Check the result JSON for ok: false and status: "cancelled" to handle early exit.

Related Functions

Signature

Inlay_INSTALL_FFMPEG ( UrlsJson )

Parameters

• UrlsJsonRequired

  Required argument for this call pattern.

Returns

Script Pattern

Inlay_INSTALL_FFMPEG ( "brew" )

Inlay_INSTALL_FFMPEG ( "{""ffmpeg"":""https://cdn.example.com/tools/ffmpeg"",""ffprobe"":""https://cdn.example.com/tools/ffprobe"",""ffplay"":""https://cdn.example.com/tools/ffplay""}" )

Use Cases

• Provision FFmpeg tools on macOS hosts before enabling advanced video flows.

Notes / Caveats

• Install step may take time based on package manager/network speed; run in admin workflows, not latency-sensitive scripts.

Related Functions

Signature

Inlay_INSTALL_WHISPER ( UrlsJson )

Parameters

• UrlsJsonRequired

  JSON object describing the artifacts to install. Required keys: `whisper_cli` (https URL of the whisper-cli binary), `sha256_whisper_cli` (64-char lowercase hex). On macOS also required: `metal_shaders` (https URL of ggml-metal.metallib) and `sha256_metal_shaders`. Optional: `force` (boolean, defaults to false; when true, reinstalls even if the SHA already matches the on-disk file).

Returns

Script Pattern

Inlay_INSTALL_WHISPER ( "{""ok"":true}" )

Use Cases

• Provision a workstation for offline transcription before any Inlay_TRANSCRIBE call.
• Re-install with `force:true` to upgrade to a new whisper-cli build after re-hosting the binary.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• The whisper-cli binary should be Mach-O universal (arm64+x86_64) for cross-architecture macOS support.
• Models are installed separately via Inlay_WHISPER_MODEL_INSTALL.

Related Functions

Signature

Inlay_WHISPER_MODEL_INSTALL ( ModelNameOrJson )

Parameters

• ModelNameOrJsonRequired

  either a bare model-name string (one of `tiny`, `tiny.en`, `base`, `base.en`, `small`, `small.en`, `medium`, `medium.en`, `large-v3`, `large-v3-turbo`) or a JSON object `{"model":"<name>","force":false}`. When `force` is true, the model is re-downloaded even if the SHA already matches the on-disk file.

Returns

Script Pattern

Inlay_WHISPER_MODEL_INSTALL ( "{""ok"":true}" )

Use Cases

• Pre-flight setup: install the model your transcribe workflow needs before any user-facing call.
• Multi-model workflows: install `small.en` for fast turnaround AND `large-v3` for archival accuracy, then choose per job at Inlay_TRANSCRIBE time.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• `.en` models are English-only and noticeably faster/smaller. Multilingual variants (no `.en` suffix) handle 99+ languages with whisper auto-detect.
• Downloads stream-verify, so a corrupted partial file never lands at the model path.

Related Functions

Signature

Inlay_TRANSCRIBE ( JSONSetElement ( "{}" ;
    [ "_inlay"    ; True       ; JSONBoolean ] ;
    [ "inputPath" ; "<input-path>" ; JSONString ] ;
    [ "model"     ; "base.en"  ; JSONString ] ;
    [ "outputs"   ; "<outputs-json-array>" ; JSONString ] ;
    [ "videoLog"  ;
        JSONSetElement ( "{}" ;
          [ "frameRate"     ; 29.97 ; JSONNumber ] ;
          [ "timecodeStart" ; "00:00:00:00" ; JSONString ] ;
          [ "boundaryMode"  ; "auto" ; JSONString ]
        )
      ; JSONObject ] ;
    [ "onCompleteScript" ; "<script-name>" ; JSONString ]
  ) )

Parameters

• ArgsJsonRequired

  JSON object. Required keys: `_inlay`:true; one of `inputPath` OR (`s3Bucket`+`s3Key`); `model` (tiny, tiny.en, base, base.en, small, small.en, medium, medium.en, large-v3, large-v3-turbo); `outputs` (non-empty array of {format, path} where format is text, json, srt, vtt, or video_log_json). Optional keys: `language` (ISO-639-1), `translate` (boolean), `s3Region`, `s3Endpoint`, `onCompleteScript`, `onCompleteScriptFile`, `onCompleteScriptParam`, `videoLog`.

• videoLogOptional

  tuning for video_log_json output. Keys: `source`, `timecodeStart`, `frameRate`, `pauseThresholdSeconds`, `minBlockSeconds`, `maxBlockSeconds`, `boundaryMode` (one of: auto, video_fade_to_black, scene_change, none, conservative, aggressive, speaker_change, topic_shift). All keys individually optional.

Returns

Script Pattern

Inlay_TRANSCRIBE ( "{""ok"":true}" )

Inlay_TRANSCRIBE ( "{""ok"":true}" ; "example" )

Use Cases

• Generate searchable SRT/VTT subtitles from interview footage as a background script step.
• Produce a video_log_json editorial log of a promo reel for ingest into NLE/MAM/DAM tools.
• Transcribe audio-only files (.mp3/.wav/.m4a) with `boundaryMode:"none"` to skip the FFmpeg pre-pass.
• Fire-and-forget with `onCompleteScript` so the FM script returns immediately and a callback handles the result.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Prerequisites: Inlay_INSTALL_WHISPER, Inlay_WHISPER_MODEL_INSTALL (for the chosen model), and Inlay_INSTALL_FFMPEG.
• Job state lives in plugin memory for the FileMaker session; FM quit drops the registry. Use Inlay_TRANSCRIBE_CLEAR_ALL to reset mid-session.
• The progress window can be cancelled by the user; the job records `status:"cancelled"` and any onCompleteScript still fires for that terminal state.
• inputPath accepts POSIX, filemac:/, file:/, filewin:/, and bare HFS forms.

Related Functions

Signature

Inlay_TRANSCRIBE_CANCEL ( JobId )

Parameters

• JobIdRequired

  the opaque id returned by Inlay_TRANSCRIBE (format `tr_<pid>_<unix_ms>_<seq>`).

Returns

Script Pattern

Inlay_TRANSCRIBE_CANCEL ( "example" )

Use Cases

• Cancel a long-running transcription when the user closes the parent record or aborts the workflow.
• Force-stop a runaway job from an admin layout.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Cancellation is cooperative: the helper kills child processes on the next ~1 s polling tick, so the actual terminal state may lag the cancel call by a second.
• The onCompleteScript callback (if any) still fires for the `cancelled` terminal state.

Related Functions

Signature

Inlay_TRANSCRIBE_STATUS ( JobId )

Parameters

• JobIdRequired

  the opaque id returned by Inlay_TRANSCRIBE.

Returns

Script Pattern

Inlay_TRANSCRIBE_STATUS ( "example" )

Use Cases

• Drive a FileMaker progress UI by repeatedly querying STATUS and updating a layout while the user works elsewhere.
• Decide branching logic on terminal state: import the transcript on `done`, surface an error dialog on `error`, do nothing on `cancelled`.
• Confirm a job exists in the registry (vs `missing`) before calling Inlay_TRANSCRIBE_CANCEL or Inlay_TRANSCRIBE_FORGET.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• This call is cheap (it reads a small status JSON file the helper updates as it works). Polling at 0.5-1 s is fine.
• Status is reset when the plugin unloads (FM quit or extension toggle). Surviving status across FM restart is not supported.

Related Functions

Signature

Inlay_TRANSCRIBE_LIST_JOBS

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_TRANSCRIBE_LIST_JOBS

Use Cases

• Confirm Inlay_TRANSCRIBE actually registered a job (vs. failed pre-spawn).
• Inspect leftover registry entries before invoking Inlay_TRANSCRIBE_CLEAR_ALL.
• Surface running/finished jobs in an admin dashboard.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Jobs persist for the FileMaker session and drop only when the plugin unloads (FM quit / extension toggle).
• `has_callback` is true if the job was started with an onCompleteScript registration that is still pending.

Related Functions

Signature

Inlay_TRANSCRIBE_FORGET ( JobId )

Parameters

• JobIdRequired

  the opaque id returned by Inlay_TRANSCRIBE.

Returns

Script Pattern

Inlay_TRANSCRIBE_FORGET ( "example" )

Use Cases

• Clean up completed jobs once their results have been imported into FileMaker.
• Suppress a stale onCompleteScript invocation when the workflow context has changed.
• Drop a single bad entry without resetting the whole session via Inlay_TRANSCRIBE_CLEAR_ALL.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• This does NOT kill the underlying whisper-cli / FFmpeg subprocess. Use Inlay_TRANSCRIBE_CANCEL first when you need to stop a running job before forgetting it.
• Idempotent: calling FORGET on an unknown or already-forgotten id is safe.

Related Functions

Signature

Inlay_TRANSCRIBE_CLEAR_ALL

Parameters

This function takes no parameters.

Returns

Script Pattern

Inlay_TRANSCRIBE_CLEAR_ALL

Use Cases

• Session reset before starting a new workflow to make sure stale jobs from a prior context don't drive callbacks.
• Diagnostic cleanup when the registry has accumulated entries from cancelled or hung jobs.
• Forced cleanup before plugin reload.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• This does NOT kill running whisper-cli / FFmpeg subprocesses. Cancel running jobs individually via Inlay_TRANSCRIBE_CANCEL first when needed.
• After CLEAR_ALL, Inlay_TRANSCRIBE_LIST_JOBS returns an empty `jobs[]` and every prior job id will return `status:"missing"` from Inlay_TRANSCRIBE_STATUS.

Related Functions

Signature

Inlay_REGISTER_LICENSE ( Key )

Parameters

• KeyRequired

  Required argument for this call pattern.

Returns

Script Pattern

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

Signature

Inlay_LICENSE_STATUS

Parameters

This function takes no parameters.

Returns

Script Pattern

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

Signature

Inlay_PLATFORM_DEACTIVATE

Parameters

This function takes no parameters.

Returns

Script Pattern

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

Signature

Inlay_SELF_UPDATE ( JSONSetElement ( "{}" ;
    [ "_inlay" ; True ; JSONBoolean ] ;
    [ "channel" ; "<stable|beta>" ; JSONString ] ;
    [ "applyUpdate" ; False ; JSONBoolean ]
  ) )

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

Script Pattern

Inlay_SELF_UPDATE

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

Use Cases

• Check release/beta/nightly availability as part of admin maintenance workflows.

Notes / Caveats

See example and related functions for usage context.

Related Functions