https://github.com/pynch-tv/nexa
RESTful API for Audio Video (Live) Production Servers
https://github.com/pynch-tv/nexa
api api-rest audiovideo blackmagicdesign evs hyperdeck linx video-editing video-player
Last synced: 6 days ago
JSON representation
RESTful API for Audio Video (Live) Production Servers
- Host: GitHub
- URL: https://github.com/pynch-tv/nexa
- Owner: pynch-tv
- Created: 2024-01-07T11:50:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T10:46:09.000Z (3 months ago)
- Last Synced: 2025-03-04T11:36:37.959Z (3 months ago)
- Topics: api, api-rest, audiovideo, blackmagicdesign, evs, hyperdeck, linx, video-editing, video-player
- Homepage: https://pyntch.tv/nexa
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nexa OpenAPI
Automate your AudioVideo servers through a unified API
Nexa provides an HTTP RESTful OpenAPI on top of existing audio video production servers - made for the broadcast integrators and programmers.
## OpenAPI
We want the API to be instantly recognizable by programmers and broadcast engineers! How? By applying all the industry best-practices and API guidelines put forward by industry: [W3C](https://www.w3.org/TR/dwbp/), [IETF](https://ietf.org), [OGC](https://ogcapi.ogc.org/), [industry best practices](https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/) and [government API Design Rules](https://gitdocumentatie.logius.nl/publicatie/api/adr/).
By following the well-known API patterns, developers can get their first successful call within minutes [TTFC](https://nordicapis.com/why-time-to-first-call-is-a-vital-api-metric) (The time taken between a developer accessing documentation, and/or signing up for an API key and making their first successful API call (of any complexity)). Additionally, by following the best practices, AI coding assistants (eg [GitHub's Co-Pilot](https://github.com/features/copilot)) can predict code more easely and accuratly.
## API for machines and humans
Nexa can render the same information in 2 ways: as [JSON](https://www.w3schools.com/whatis/whatis_json.asp) (for machine consumption) and in [HTML](https://www.w3schools.com/html/html_intro.asp) (for human consumption).
A side-by-side comparison between HTML and JSON respectively:
The one on the left (HTML) is called with http://localhost:8080/acme/unit11/v1/ and the one on the right (JSON) with http://localhost:8080/acme/unit11/v1/?f=json (see the difference?).
## Installation
Nexa comes as an offline installer (that makes it slightly larger) that does not require an internet connection. Typically production server are not exposed to the internet, for security (and other) reasons. The installer is self contained and will only install what is really needed. The installer does not mess with the Windows Registry, nor with any other settings that might affect the behaviour of running applications.
Nexa must be installed in the network that is used by the servers. More on the installation process [here](https://github.com/pynch-tv/Nexa/wiki).