LiveOpenreSlotBindResult live.openre-slot-bind-result@1

Generated at from openvibe-contracts v0.127.0 and openvibe-sdk v0.37.0.

Version
1.0.0
Owner
live
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/live/openre-slot-bind-result.v1.json

live.openre-slot-bind-result@1: the answer of POST /internal/openre/slots: the Live slot (managed_stream_id) now ingested by OpenRestream for that stream, the channel it shows on, and created false when the slot already existed. Refusals are problem bodies: 400 (bad body), 409 live.no_account (no Live account for that subject yet), 409 live.slot_taken (the stream is bound to another person's slot).

Fields

FieldTypeRequiredDescriptionConstraints
managed_stream_idintegeryes
  • minimum 1
channel_urlstringyes
  • format uri
createdbooleanyes

Examples

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

Valid: created
{
  "managed_stream_id": 31,
  "channel_url": "https://openvibe.live/@alex",
  "created": true
}
Rejected: zero-id
{
  "managed_stream_id": 0,
  "channel_url": "https://openvibe.live/@alex",
  "created": false
}

Validate

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