Reference Materials

Materials for working with a node bypassing the interface and for checking terms: reference documents on the HTTP API and the settings file, machine-readable schemas of the settings file, and a glossary of the terms found in the manual and in the interface.

• Glossary
  • MPEG-TS transport stream
  • Network and delivery
  • Licence

Reference documents and schemas

The reference documents describe the HTTP API for configuration and data, the format of the settings file, and the procedure for editing and carrying it over. The schemas are a machine-readable description of the settings file in JSON Schema format, in a strict and a permissive variant. The documents are written in English and published on the documentation site, one directory per product version:

https://doc2.pstreamer.tv/reference/      four reference documents
https://doc2.pstreamer.tv/schema/         two schemas

Take the directory of the version you have installed; if there is no directory for it, take the nearest earlier one. A reference for another release does not describe your node. What each document contains and how to use them is covered in Reference documents; checking the settings file against the schema, in Checking against the JSON Schema.