CamSettings cam.settings@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
cam
Visibility
public
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/cam/settings.v1.json

cam.settings@1: a person's camera choices. Lens and mic are hints because browser device ids may differ across devices.

Fields

FieldTypeRequiredDescriptionConstraints
facingenumyes
  • one of "user", "environment"
lensstringyes
  • minLength 1
  • maxLength 120
micstringyes
  • minLength 1
  • maxLength 120
resolutionenumyes
  • one of "480", "720", "1080"
mirrorbooleanyes
updated_atstring | nullyes
  • format date-time

Examples

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

Valid: default
{
  "facing": "user",
  "lens": "main",
  "mic": "default",
  "resolution": "720",
  "mirror": true,
  "updated_at": null
}
Rejected: facing
{
  "facing": "side",
  "lens": "main",
  "mic": "default",
  "resolution": "720",
  "mirror": true,
  "updated_at": null
}

Validate

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