Node-RED

Official package: node-red-contrib-dearscenario-player (shipped under ecosystem/node-red-contrib-dearscenario-player in the DearScenario Player repository).

Nodes talk to the same HTTP API as every other integrator: POST /api/command and GET /api/status.

Install

In Node-RED (Palette Manager) or:

cd ~/.node-red
npm install <path-or-package-for-node-red-contrib-dearscenario-player>

Restart Node-RED after install.

Access requirements

DearScenario Player does not use a shared control token. Run Node-RED where it can reach the configured listener. If network.controller_ip_whitelist is non-empty, add the Node-RED host's exact source IP.

Nodes

Command overrides

• msg.cmd overrides the configured command name
• object msg.payload becomes params

Success leaves msg.payload as response.result. Failures use a second output with a normalized msg.error.

Minimal flow

1. Add diria-config with the player IP and base_port (default 18290).
2. Wire an inject → diria-command (play / load / seek, …).
3. Optionally add diria-status when a flow needs playback feedback.

Use the Command Reference for parameter schemas. For playback observation, see Status API.

The Node-RED command dropdown is a static snapshot of the current public catalog (lib/commands.json), not a runtime /api/spec query (removed) and not yet the future stable 10-command core. Narrowing that list is C1/C3. msg.cmd can still send any command the player accepts.

Related

• HTTP API
• Companion
• Security

Previous / Next

• Previous: Companion
• Next: Status API