OpenreOutputWriteResult openre.output-write-result@1

Generated at 2026-09-26 00:45:03 UTC from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version

1.0.0

Owner

openre

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/openre/output-write-result.v1.json

openre.output-write-result@1: answers of openre.output.write on OpenRe.Stream. POST …/destinations → 201 { destination }; PATCH /api/v1/destinations/:id → { destination }; DELETE → 204 with no body (409 openre.destination_running while it still runs); POST …/test → { ok, checks } (URL rules, DNS, TCP reachability; each check { check, ok, detail }); POST …/start → { output } (for the stream's live session; 409 when held, disabled, keyless or not live); POST …/stop → { stopping } (outputs asked to stop).

Fields

This schema has no named fields.

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

{
  "output": {
    "id": "out_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "session_id": "ses_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "destination_id": "dst_01JAB2C3D4E5F6G7H8J9K0MNPQ",
    "desired": "run",
    "state": "live",
    "worker": {
      "id": "wrk_1",
      "generation": 4
    },
    "restart_attempts": 0,
    "max_restart_attempts": 5,
    "next_restart_at": null,
    "ever_live": true,
    "last_error": null,
    "progress": {
      "fps": 30
    },
    "started_at": "2026-09-25T21:00:02.000Z",
    "live_at": "2026-09-25T21:00:04.000Z",
    "uptime_ms": 360000,
    "ended_at": null,
    "updated_at": "2026-09-25T21:06:04.000Z"
  }
}

{
  "ok": false,
  "checks": [
    {
      "check": "url",
      "ok": true,
      "detail": "rtmp"
    },
    {
      "check": "tcp",
      "ok": false,
      "detail": "timeout after 5000 ms"
    }
  ]
}

{
  "stopping": -1
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('openre.output-write-result@1', value);   // { valid, errors: [{ path, message }] }