OpenreOutputReadResult openre.output-read-result@1

Generated at 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-read-result.v1.json

openre.output-read-result@1: answers of openre.output.read on OpenRe.Stream. GET /api/v1/streams/:id/destinations → { destinations }; GET /api/v1/sessions/:id/outputs → { outputs } (with health); GET /api/v1/destinations/:id/logs and GET /api/v1/outputs/:id/logs?limit= → { logs } (newest first, at most 500).

Fields

This schema has no named fields.

Examples

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

Valid: destinations
{
  "destinations": [
    {
      "id": "dst_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "stream_id": "def_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "platform": "twitch",
      "name": "Twitch",
      "server_url": "rtmp://live.twitch.tv/app",
      "transport": "rtmp",
      "has_stream_key": true,
      "stream_key_hint": "****a1b2",
      "has_srt_passphrase": false,
      "srt_latency_ms": null,
      "enabled": true,
      "auto_start": true,
      "quality_preset": "source",
      "custom_video_bitrate": null,
      "custom_audio_bitrate": null,
      "custom_fps": null,
      "custom_encoder_preset": null,
      "hold_reason": null,
      "consecutive_failures": 0,
      "cooldown_until": null,
      "cooldown_ms": 0,
      "last_error": null,
      "last_failed_at": null,
      "created_at": "2026-09-20T10:00:00.000Z",
      "updated_at": "2026-09-20T10:00:00.000Z"
    }
  ]
}
Valid: logs
{
  "logs": [
    {
      "output_id": "out_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "level": "warn",
      "message": "reconnecting",
      "at": "2026-09-25T21:03:00.000Z"
    }
  ]
}
Rejected: partial-log
{
  "logs": [
    {
      "level": "warn"
    }
  ]
}

Validate

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