Project Documentation

Res_file_watch

quickPlace MVP: a local helper app that accelerates ingest into Resolume by targeting first-empty clips, with optional DXV conversion and watch-folder automation.

Primary App URL localhost:17320
Core Integration Resolume REST API
Media Engine ffmpeg + ffprobe
Automation Single Active Watcher

What It Solves

Removes manual ingest friction by routing media into the first available clip position on a selected layer, with options for conversion and immediate triggering.

Layer-aware Batch-ready Watch Folder

Requirements

  • Node.js 18+ runtime.
  • ffmpeg and ffprobe available in PATH.
  • Resolume running with REST API enabled at http://127.0.0.1:8080/api/v1 (default).

Run & Access

  1. Start app from project root: npm start
  2. Open http://localhost:17320
  3. Refresh layers and select target layer.
  4. Choose File or Folder mode for ingest.

Feature Highlights

Dual Ingest Modes

Single-file ingest or filename-ordered folder ingest into sequential open slots.

DXV Conversion Path

Optional conversion for non-DXV media, including still-image handling to one-frame DXV clips.

Watch Folder Tab

Monitor one folder continuously and auto-ingest new media after conversion checks.

Auto-trigger Option

Trigger clip immediately after placement for rapid show prep and operator flow.

Current MVP Constraints

  • No advanced queueing or retry model for lock conflicts yet.
  • One active watcher at a time.
  • Converted files are written beside source files using `_converted` suffixes.
  • API port/base URL persistence is local to the user machine config file.

User Instructions: Quick Place Flow

  1. Set Resolume API port and click Save Port, then refresh layers.
  2. Select target layer and choose File or Folder mode.
  3. Set conversion and auto-trigger options based on show needs.
  4. Place media and monitor status/recent jobs for results.
File Mode Folder Mode First Open Slot

Watch Folder Instructions

  • Open Watch Folder tab and enter an absolute watch path.
  • Select target watch layer and optional auto-trigger behavior.
  • Start Watch to ingest new files automatically as they arrive.
  • Watch status counters for processed files, failures, queue, and last activity.
  • Use Stop Watch to pause ingest; current design supports one watcher at a time.

Instruction Highlights

Input Priority

In File mode, manual absolute file path takes priority over a dropped/uploaded file.

Media Support

Supports common video/image extensions; still images can convert into one-frame DXV clips.

Safe Placement Logic

Placement targets selected layer only and avoids occupied slots by choosing first open clip position.

Conversion Naming

Converted outputs use incremental naming: _converted, _converted_2, and so on.

Troubleshooting Checklist

  • If layers do not load, verify Resolume is running and API port is correct, then click Refresh.
  • If placement fails, confirm source path access and open slots on selected layer.
  • If conversion fails, confirm ffmpeg and ffprobe are available in PATH.
  • If watch feels idle, confirm watched folder path, extension support, and last error in watch status.