Signature

Inlay_GET_BOOTTIME ( { CacheBuster } )

Parameters

• CacheBusterOptional

  Optional argument. Omit to use the default behavior.

Returns

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

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

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

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

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

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

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

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 ( "{}" ;
    [ "OutputPath?" ; "/Users/alice/Reports/Q1.xlsx" ; JSONString ] ;
    [ "Sheets" ; "[{\"name\":\"Summary\",\"rows\":[[\"Item\",\"Total\"]]}]" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

Returns

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

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

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

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

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

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_FINDER_INSTALL ( JSONSetElement ( "{}" ;
    [ "WorkflowName" ; "send_to_fm" ; JSONString ] ;
    [ "MenuNoun?" ; "FileMaker" ; JSONString ] ;
    [ "OnReceiveScript?" ; "ImportClip" ; JSONString ] ;
    [ "OnReceiveScriptFile?" ; "MySolution" ; JSONString ]
  ) )

Parameters

• WorkflowNameOptional

  identifier of a bundled workflow. v1 supports only "send_to_fm".

• MenuNounOptional

  the noun appended to "Send to " in the Quick Action menu. Defaults to "FileMaker" when omitted or empty.

• OnReceiveScriptOptional

  a FileMaker script to run each time a file is sent. When set, after writing the inbox the helper fires an fmp:// URL that runs this script; the script should call Inlay_FINDER_GETPATH to read the file envelope. Requires OnReceiveScriptFile.

• OnReceiveScriptFileOptional

  the FileMaker database file (your solution's filename, e.g. "MySolution") that contains OnReceiveScript. This is your solution, NOT the file the user right-clicked. Required whenever OnReceiveScript is set.

Returns

Use Cases

• Push mode: set OnReceiveScript + OnReceiveScriptFile. Right-clicking a file and choosing "Send to <noun>" writes the inbox and triggers your script via an fmp:// URL; your script calls Inlay_FINDER_GETPATH to read the envelope {"Path":...,"Name":...,"Size":...,"Mtime":...}.
• Poll mode: omit OnReceiveScript and drain the inbox yourself with Inlay_FINDER_GETPATH on a script timer.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Push mode requires the fmurlscript extended privilege ("Allow URL script execution") enabled on the privilege set used to open OnReceiveScriptFile, and that file must be open when a file is sent.
• Idempotent: safe to call on every solution open. The callback config is stored on disk, so push mode survives FileMaker restarts; you do not need to re-run this on every open.
• Windows equivalent: Inlay_ExplorerContext_INSTALL.

Related Functions

Signature

Inlay_FINDER_GETPATH

Parameters

This function takes no parameters.

Returns

Use Cases

• Bind a button to Set Variable [ $payload; Value: Inlay_FINDER_GETPATH ] then branch on IsEmpty($payload) to detect whether anything is waiting.
• Use an OnTimer or layout-entry script trigger to drain the inbox automatically.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Pair with Inlay_FINDER_INSTALL("send_to_fm") once during solution setup.
• Single-slot semantics: only the last "Send to FileMaker" action survives until consumed.
• Inbox: ~/Library/Application Support/Inlay/finder-inbox.json.
• Windows equivalent: Inlay_ExplorerContext_GETPATH.

Related Functions

Signature

Inlay_ExplorerContext_INSTALL ( JSONSetElement ( "{}" ;
    [ "WorkflowName" ; "send_to_fm" ; JSONString ] ;
    [ "MenuNoun?" ; "FileMaker" ; JSONString ] ;
    [ "OnReceiveScript?" ; "ImportClip" ; JSONString ] ;
    [ "OnReceiveScriptFile?" ; "MySolution" ; JSONString ]
  ) )

Parameters

• WorkflowNameOptional

  identifier of a bundled workflow. v1 supports only "send_to_fm".

• MenuNounOptional

  the noun appended to "Send to " in the menu. Defaults to "FileMaker" when omitted or empty.

• OnReceiveScriptOptional

  a FileMaker script to run each time a file is sent. When set, after writing the inbox the helper fires an fmp:// URL that runs this script; the script should call Inlay_ExplorerContext_GETPATH to read the file envelope. Requires OnReceiveScriptFile.

• OnReceiveScriptFileOptional

  the FileMaker database file (your solution's filename, e.g. "MySolution") that contains OnReceiveScript. This is your solution, NOT the file the user right-clicked. Required whenever OnReceiveScript is set.

Returns

Use Cases

• Push mode: set OnReceiveScript + OnReceiveScriptFile. Right-clicking a file and choosing "Send to <noun>" writes the inbox and triggers your script via an fmp:// URL; your script calls Inlay_ExplorerContext_GETPATH to read the envelope {"Path":...,"Name":...,"Size":...,"Mtime":...}.
• Poll mode: omit OnReceiveScript and drain the inbox yourself with Inlay_ExplorerContext_GETPATH on a script timer.

Notes / Caveats

• Windows only. Calls from unsupported platforms return an error response.
• Push mode requires the fmurlscript extended privilege ("Allow URL script execution") enabled on the privilege set used to open OnReceiveScriptFile, and that file must be open when a file is sent.
• Idempotent: safe to call on every solution open. The callback config is stored on disk, so push mode survives FileMaker restarts; you do not need to re-run this on every open.
• macOS equivalent: Inlay_FINDER_INSTALL.

Related Functions

Signature

Inlay_ExplorerContext_GETPATH

Parameters

This function takes no parameters.

Returns

Use Cases

• Bind a button to Set Variable [ $payload; Value: Inlay_ExplorerContext_GETPATH ] then branch on IsEmpty($payload) to detect whether anything is waiting.
• Use an OnTimer or layout-entry script trigger to drain the inbox automatically.

Notes / Caveats

• Windows only. Calls from unsupported platforms return an error response.
• Pair with Inlay_ExplorerContext_INSTALL("send_to_fm") once during solution setup.
• Single-slot semantics: only the last "Send to FileMaker" action survives until consumed.
• Inbox: %LOCALAPPDATA%\Inlay\finder-inbox.json.
• macOS equivalent: Inlay_FINDER_GETPATH.

Related Functions

Signature

Inlay_FINDER_UNINSTALL ( workflowName )

Parameters

• workflowNameOptional

  identifier of the workflow to remove. v1 supports only "send_to_fm".

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

• macOS only. Calls from unsupported platforms return an error response.
• Idempotent: safe to call even if never installed.
• Windows equivalent: Inlay_ExplorerContext_UNINSTALL.

Related Functions

Signature

Inlay_ExplorerContext_UNINSTALL ( workflowName ; menuNoun )

Parameters

• workflowNameOptional

  identifier of the workflow to remove. v1 supports only "send_to_fm".

• menuNounOptional

  must match the noun used at install time (default "FileMaker"). Used to locate the correct .lnk filename.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

• Windows only. Calls from unsupported platforms return an error response.
• Idempotent: safe to call even if never installed.
• macOS equivalent: Inlay_FINDER_UNINSTALL.

Related Functions

Signature

Inlay_RENDER_DROPZONE_HTML ( JSONSetElement ( "{}" ;
    [ "PromptText?" ; "Drop_a_file_here" ; JSONString ] ;
    [ "MaxSizeBytes?" ; 0 ; JSONNumber ] ;
    [ "ImageUrl?" ; "" ; JSONString ]
  ) { ; SourceContainer } )

Parameters

• PromptTextOptional

  label shown inside the drop zone. Default "Drop a file here".

• MaxSizeBytesOptional

  reject drops larger than this many bytes. Omit or 0 for unlimited.

• ImageUrlOptional

  an image shown above the prompt text. Accepts an https URL or a data: URI. Omit for a text-only drop zone.

• SourceContainerOptional

  a FileMaker container field whose image is shown above the prompt text. The plugin reads the container bytes and embeds them as a data: URI, picking the MIME automatically from the typed image stream (JPEG, PNG, GIF, BMP) or by sniffing the FILE stream for WebP or SVG. If the container holds bytes that are not a recognized image format, the call returns an error. Passing both ImageUrl and SourceContainer is rejected to keep intent explicit.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_GENERATE_SECRET ( { ByteLength } )

Parameters

• ByteLengthOptional

  Optional argument. Omit to use the default behavior.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_PROVISIONING_URI ( Secret ; AccountName ; { Issuer } ; { Digits } ; { Period } )

Parameters

• SecretRequired

  Required argument for this call pattern.

• AccountNameRequired

  Required argument for this call pattern.

• IssuerOptional

  Optional argument. Omit to use the default behavior.

• DigitsOptional

  Optional argument. Omit to use the default behavior.

• PeriodOptional

  Optional argument. Omit to use the default behavior.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_QR ( Uri ; { Format } ; { PixelsPerModule } )

Parameters

• UriRequired

  Required argument for this call pattern.

• FormatOptional

  Optional argument. Omit to use the default behavior.

• PixelsPerModuleOptional

  Optional argument. Omit to use the default behavior.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_NOW ( Secret ; { Digits } ; { Period } )

Parameters

• SecretRequired

  Required argument for this call pattern.

• DigitsOptional

  Optional argument. Omit to use the default behavior.

• PeriodOptional

  Optional argument. Omit to use the default behavior.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_VERIFY ( Secret ; Code ; { Window } ; { Digits } )

Parameters

• SecretRequired

  Required argument for this call pattern.

• CodeRequired

  Required argument for this call pattern.

• WindowOptional

  Optional argument. Omit to use the default behavior.

• DigitsOptional

  Optional argument. Omit to use the default behavior.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_WRAP ( Base32Secret ; Passphrase )

Parameters

• Base32SecretRequired

  Required argument for this call pattern.

• PassphraseRequired

  Required argument for this call pattern.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_UNWRAP ( Blob ; Passphrase )

Parameters

• BlobRequired

  Required argument for this call pattern.

• PassphraseRequired

  Required argument for this call pattern.

Returns

Use Cases

• See example and related functions for usage context.

Notes / Caveats

See example and related functions for usage context.

Related Functions

Signature

Inlay_TOTP_BACKUP_GENERATE ( { Count } ; { Length } )

Parameters

• CountOptional

  Optional argument. Omit to use the default behavior.

• LengthOptional

  Optional argument. Omit to use the default behavior.

Returns

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

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

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 ( "{}" ;
    [ "Url" ; "https://example.com/image.jpg" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• UrlOptional

  Optional argument. Omit to use the default behavior.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

Returns

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "DestinationFolder" ; "upload/2026" ; JSONString ] ;
    [ "DestinationFilename?" ; "clip.mp4" ; JSONString ] ;
    [ "Metadata?" ; JSONSetElement ( "{}" ;
                  [ "RecordId"    ; "022"        ; JSONString ] ;
                  [ "UploadedBy"  ; "g.shumway"  ; JSONString ]
              ) ; JSONString ] ;
    [ "TtlHoursOverride?" ; 0 ; JSONNumber ]
  ) ;
  S3::SourceContainer
)

Parameters

• ConfigRequired

  a saved config name (string) or an inline object with keys Domain, Region, AccessKey, SecretKey, Bucket. NOT the same as ConfigKey in Inlay_S3_SET_CONFIG; that one is a save-name, this one is the runtime config to use.

• DestinationFolderRequired

  S3 key prefix, e.g. "media/2026" or "" for root.

• SourceContainerRequired

  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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "DestinationFolder" ; "media/2026" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• ConfigKeyOptional

  Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

• DestinationFolderOptional

  Bucket folder/prefix where uploaded files should be stored.

Returns

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; JSONString ] ;
    [ "ExpectedHash" ; "a1b2c3d4e5f6..." ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• ConfigKeyOptional

  Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

• PathToFileOptional

  Optional argument. Omit to use the default behavior.

• ExpectedHashOptional

  Expected SHA-256 hash (hex) used for integrity comparison.

Returns

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "001" ; JSONString ] ;
    [ "Domain?" ; ".digitaloceanspaces.com" ; JSONString ] ;
    [ "Region?" ; "us-east-1" ; JSONString ] ;
    [ "AccessKey?" ; "YOUR_ACCESS_KEY_ID" ; JSONString ] ;
    [ "SecretKey?" ; "YOUR_SECRET_ACCESS_KEY" ; JSONString ] ;
    [ "Bucket?" ; "your-bucket-name" ; JSONString ] ;
    [ "TtlHours?" ; 0 ; JSONNumber ] ;
    [ "EncryptKey?" ; "your-cache-passphrase" ; JSONString ] ;
    [ "WaitForCompletion?" ; False ; JSONBoolean ]
  ) )

Parameters

• ConfigKeyOptional

  the name under which to save this S3 config. This is a save-name, not the config itself. Other Inlay_S3_* functions accept this name in their Config argument.

• Optional

  Domain, Region, AccessKey, SecretKey, Bucket (required): S3 connection credentials.

• TtlHoursOptional

  default cache TTL for GET operations.

• EncryptKeyOptional

  default cache encryption key.

• WaitForCompletionOptional

  if false, PUT operations return immediately.

Returns

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "SourcePathToFile" ; "media/2026/clip.mxf" ; JSONString ] ;
    [ "DestinationPathToFile?" ; "/Users/alice/Downloads/clip.mxf" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• ConfigKeyOptional

  Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

Returns

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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathToFile" ; "media/2026/clip.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "Action" ; "register" ; JSONString ] ;
    [ "ReadOnly" ; False ; JSONBoolean ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• ConfigKeyOptional

  Name of the S3 profile previously registered with Inlay_S3_SET_CONFIG.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

Returns

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 ( "{}" ;
    [ "SourceConfig" ; "prod" ; JSONString ] ;
    [ "SourcePathToFileOrFolder" ; "media/2026/clip.mxf" ; JSONString ] ;
    [ "DestinationConfig" ; "archive" ; JSONString ] ;
    [ "DestinationPathToFileOrFolder" ; "archive/2026/clip.mxf" ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

• SourceConfigOptional

  Optional argument. Omit to use the default behavior.

• JSONStringOptional

  Optional argument. Omit to use the default behavior.

• SourcePathToFileOrFolderOptional

  Object key path inside your bucket (for example, posters/episode1/keyart.jpg).

• DestinationConfigOptional

  Optional argument. Omit to use the default behavior.

• DestinationPathToFileOrFolderOptional

  Absolute local destination path for downloaded output.

Returns

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "SourcePathToFileOrFolder" ; "media/2026/clip.mxf" ; JSONString ] ;
    [ "DestinationPathToFileOrFolder" ; "media/2026/clip-backup.mxf" ; 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

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 ( "{}" ;
    [ "ConfigKey" ; "prod" ; JSONString ] ;
    [ "PathsToFiles" ; List (
        "media/2026/clip1.mxf" ;
        "media/2026/clip2.mxf"
    ) ; JSONString ]
  ) )

Parameters

• JSONSetElementRequired

  Required argument for this call pattern.

Returns

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 ( "{}" ;
    [ "Action" ; "tc_to_frames" ; JSONString ] ;
    [ "Arg1?" ; "01:00:00:00" ; 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

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

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 ( "{}" ;
    [ "InputPath?" ; "/Users/alice/Media/raw.mov" ; JSONString ] ;
    [ "OutputPath?" ; "/Users/alice/Media/out.mp4" ; 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

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

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

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

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 ( "{}" ;
    [ "InputPathToFile?" ; "/Media/interview.mov" ; JSONString ] ;
    [ "Model?"           ; "base.en"    ; JSONString ] ;
    [ "Outputs?"         ; "[{\"format\":\"text\",\"path\":\"/tmp/out.txt\"}]" ; JSONString ] ;
    [ "VideoLog?"  ;
        JSONSetElement ( "{}" ;
          [ "frameRate"     ; 29.97 ; JSONNumber ] ;
          [ "timecodeStart" ; "00:00:00:00" ; JSONString ] ;
          [ "boundaryMode"  ; "auto" ; JSONString ]
        )
      ; JSONObject ] ;
    [ "OnCompleteScript?" ; "Handle_Transcribe_Done" ; JSONString ]
  ) )

Parameters

• ArgsJsonRequired

  JSON object. Required keys: one of InputPathToFile 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

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.
• InputPathToFile accepts POSIX, filemac:/, file:/, filewin:/, and bare HFS forms.
• Legacy keys inputPath, s3Bucket, s3Key, s3Region, s3Endpoint, model, language, translate, outputs, onCompleteScript, onCompleteScriptFile, onCompleteScriptParam, videoLog are accepted for one release cycle.

Related Functions

Signature

Inlay_TRANSCRIBE_CANCEL ( JobId )

Parameters

• JobIdRequired

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

Returns

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

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

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

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

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

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

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

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 ( "{}" ;
    [ "Channel?" ; "stable" ; 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

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