Personal tools

Difference between revisions of "Rivendell Design Documentation"

From Rivendell Wiki

Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Public APIs ==
 
== Public APIs ==
* [https://opsguide.rivendellaudio.org/apis/web_api.pdf Rivendell Web API]. Can be used to enable third-party interaction with most elements of a Rivendell system.  
+
* 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.  
  
* PyPAD Program Associated Data Distribution 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.
 
A [https://pypi.org/project/rivendellaudio/ Python 3 binding] is available that provides access to both of the above APIs.
  
== Internal 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]
 
* Core Audio Engine Protocol [https://opsguide.rivendellaudio.org/apis/html/cae.html HTML] [https://opsguide.rivendellaudio.org/apis/cae.pdf PDF]
  

Latest revision as of 16:16, 20 July 2023

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