OpenreOutputWriteRequest openre.output-write-request@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-request.v1.json

openre.output-write-request@1: the body of POST /api/v1/streams/:id/destinations (platform and server_url required) and PATCH /api/v1/destinations/:id (fields left out keep their value) on OpenRe.Stream (openre.output.write). server_url must pass the destination URL rules (rtmp, rtmps or srt, public hosts); stream_key (at most 512 characters, no spaces) and srt_passphrase (10 to 79 characters) are sealed and never read back — __keep__ leaves them unchanged, empty clears them. Numbers out of range become null: srt_latency_ms 20-8000, custom_video_bitrate 500-50000, custom_audio_bitrate 32-512, custom_fps 15-120; an unknown custom_encoder_preset becomes null. DELETE /api/v1/destinations/:id and POST /api/v1/destinations/:id/test|start|stop take no body.

Fields

This schema has no named fields.

Examples

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

{
  "platform": "custom",
  "name": "Backup",
  "server_url": "srt://backup.example.net:9000",
  "srt_passphrase": "correct-horse-battery",
  "srt_latency_ms": 200,
  "auto_start": false
}

{
  "platform": "facebook",
  "server_url": "rtmps://live-api-s.facebook.com:443/rtmp/"
}

Validate

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