obs-webrtc-server/schema.json

Web server allowing browsers connected to it to share their camera/microphone/screen, which are automatically added as sources in OBS Studio and can be recorded individually.

{"type":"object","properties":{"obsServer":{"type":"string"},"obsPassword":{"type":"string"},"obsPort":{"type":"number"},"obsScenePrefix":{"type":"string"},"obsSceneExtraSources":{"type":"array","items":{"type":"string"}},"tlsCertificate":{"$ref":"#/definitions/TLSCertificate"},"listenPort":{"type":"number"},"listenHost":{"type":"string"},"emitterPaths":{"type":"array","items":{"type":"string"}},"adminPaths":{"type":"array","items":{"type":"string"}},"receiverPrefix":{"type":"string"},"rtcConfiguration":{"$ref":"#/definitions/RTCConfiguration"},"mediaConstraints":{"$ref":"#/definitions/MediaStreamConstraints"},"recordPrefix":{"type":"string"},"recordingsFolder":{"type":"string"},"recordOptions":{"$ref":"#/definitions/MediaRecorderOptions"},"targetDelay":{"type":"number"},"log":{"type":"string"}},"additionalProperties":false,"definitions":{"TLSCertificate":{"type":"object","properties":{"certificate":{"type":"string"},"privateKey":{"type":"string"}},"additionalProperties":false,"required":["certificate","privateKey"]},"RTCConfiguration":{"type":"object","properties":{"bundlePolicy":{"enum":["balanced","max-bundle","max-compat"],"type":"string"},"certificates":{"type":"array","items":{"$ref":"#/definitions/RTCCertificate"}},"iceCandidatePoolSize":{"type":"number"},"iceServers":{"type":"array","items":{"$ref":"#/definitions/RTCIceServer"}},"iceTransportPolicy":{"enum":["all","relay"],"type":"string"},"rtcpMuxPolicy":{"const":"require","type":"string"}},"additionalProperties":false},"RTCCertificate":{"type":"object","properties":{"expires":{"type":"number"}},"additionalProperties":false,"required":["expires"]},"RTCIceServer":{"type":"object","properties":{"credential":{"type":"string"},"urls":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"username":{"type":"string"}},"additionalProperties":false,"required":["urls"]},"MediaStreamConstraints":{"type":"object","properties":{"audio":{"anyOf":[{"$ref":"#/definitions/MediaTrackConstraints"},{"type":"boolean"}]},"peerIdentity":{"type":"string"},"preferCurrentTab":{"type":"boolean"},"video":{"anyOf":[{"$ref":"#/definitions/MediaTrackConstraints"},{"type":"boolean"}]}},"additionalProperties":false},"MediaTrackConstraints":{"type":"object","properties":{"advanced":{"type":"array","items":{"$ref":"#/definitions/MediaTrackConstraintSet"}},"aspectRatio":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"autoGainControl":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"channelCount":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"deviceId":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"echoCancellation":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"facingMode":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"frameRate":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"groupId":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"height":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"latency":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"noiseSuppression":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"sampleRate":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"sampleSize":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"suppressLocalAudioPlayback":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"width":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]}},"additionalProperties":false},"MediaTrackConstraintSet":{"type":"object","properties":{"aspectRatio":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"autoGainControl":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"channelCount":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"deviceId":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"echoCancellation":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"facingMode":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"frameRate":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"groupId":{"anyOf":[{"type":"array","items":{"type":"string"}},{"$ref":"#/definitions/ConstrainDOMStringParameters"},{"type":"string"}]},"height":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"latency":{"anyOf":[{"$ref":"#/definitions/ConstrainDoubleRange"},{"type":"number"}]},"noiseSuppression":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"sampleRate":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"sampleSize":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]},"suppressLocalAudioPlayback":{"anyOf":[{"$ref":"#/definitions/ConstrainBooleanParameters"},{"type":"boolean"}]},"width":{"anyOf":[{"$ref":"#/definitions/ConstrainULongRange"},{"type":"number"}]}},"additionalProperties":false},"ConstrainDoubleRange":{"type":"object","properties":{"exact":{"type":"number"},"ideal":{"type":"number"},"max":{"type":"number"},"min":{"type":"number"}},"additionalProperties":false},"ConstrainBooleanParameters":{"type":"object","properties":{"exact":{"type":"boolean"},"ideal":{"type":"boolean"}},"additionalProperties":false},"ConstrainULongRange":{"type":"object","properties":{"exact":{"type":"number"},"ideal":{"type":"number"},"max":{"type":"number"},"min":{"type":"number"}},"additionalProperties":false},"ConstrainDOMStringParameters":{"type":"object","properties":{"exact":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"ideal":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},"additionalProperties":false},"MediaRecorderOptions":{"type":"object","properties":{"audioBitsPerSecond":{"type":"number"},"bitsPerSecond":{"type":"number"},"mimeType":{"type":"string"},"videoBitsPerSecond":{"type":"number"}},"additionalProperties":false}},"$schema":"http://json-schema.org/draft-07/schema#"}