Jump to content

Rivendell Design Documentation: Difference between revisions

From Rivendell Wiki
No edit summary
imported>ImportBot
Imported from scrape
 
Line 1: Line 1:
Rivendell Design Documentation (and other documentation) can be found on the main [http://www.rivendellaudio.org Rivendell website].
== Public APIs ==
* Rivendell Web Interface API. [https://opsguide.rivendellaudio.org/apis/html/web_api.html HTML] [https://opsguide.rivendellaudio.org/apis/web_api.pdf PDF]. Can be used to enable third-party interaction with most elements of a Rivendell system.
 
* [https://opsguide.rivendellaudio.org/html/chapter.pad.html Program Associated Data (PAD) Distribution System].
 
A [https://pypi.org/project/rivendellaudio/ Python 3 binding] is available that provides access to both of the above APIs.
 
== Internal Architecture and API Documentation ==
* Core Audio Engine Protocol [https://opsguide.rivendellaudio.org/apis/html/cae.html HTML] [https://opsguide.rivendellaudio.org/apis/cae.pdf PDF]
 
* Font Management System [https://opsguide.rivendellaudio.org/apis/html/fonts.html HTML] [https://opsguide.rivendellaudio.org/apis/fonts.pdf PDF]
 
* Multicast Notification Protocol [https://opsguide.rivendellaudio.org/apis/html/notification.html HTML] [https://opsguide.rivendellaudio.org/apis/notification.pdf PDF]
 
* Rivendell Interprocess Communication Protocol [https://opsguide.rivendellaudio.org/apis/html/ripc.html HTML] [https://opsguide.rivendellaudio.org/apis/ripc.pdf PDF]

Latest revision as of 10:18, 9 May 2026

Public APIs

  • Rivendell Web Interface API. HTML PDF. Can be used to enable third-party interaction with most elements of a Rivendell system.

A Python 3 binding is available that provides access to both of the above APIs.

Internal Architecture and API Documentation

  • Core Audio Engine Protocol HTML PDF
  • Multicast Notification Protocol HTML PDF
  • Rivendell Interprocess Communication Protocol HTML PDF