diff --git a/docs/engine-features.md b/docs/engine-features.md index 8934abd215bd20dacb6a2263025991ee6c11f6ab..c92c6842888500771f9b05b6c14640be7ea24834 100644 --- a/docs/engine-features.md +++ b/docs/engine-features.md @@ -1,6 +1,28 @@ # Aura Engine Features -This page gives a more detailed overview of the Aura Engine features. +This page gives a more detailed overview of the Aura Engine features and how to configure them. + +<!-- TOC --> + +- [Aura Engine Features](#aura-engine-features) + - [Input](#input) + - [Play audio from multiple sources](#play-audio-from-multiple-sources) + - [Dynamic switching of sources](#dynamic-switching-of-sources) + - [Output](#output) + - [Record output to filesystem](#record-output-to-filesystem) + - [Stream output to an Icecast Server](#stream-output-to-an-icecast-server) + - [Multichannel Line-out](#multichannel-line-out) + - [Blank Detenction / Silence Detecter](#blank-detenction--silence-detecter) + - [Auto Pilot a.k.a. Fallback Handling](#auto-pilot-aka-fallback-handling) + - [API Endpoints](#api-endpoints) + - [Web Applications](#web-applications) + - [Monitoring](#monitoring) + - [Send mails on errors and warnings](#send-mails-on-errors-and-warnings) + - [Engine Status Information](#engine-status-information) + - [Engine Heartbeat](#engine-heartbeat) + - [Read more](#read-more) + +<!-- /TOC --> ## Input @@ -215,7 +237,7 @@ This heartbeat is sent continiously based on the configured `heartbeat_frequency # Server where heartbeat info is sent to heartbeat_server = "127.0.0.1" # Some UDP port -heartbeat_port = 43334 +heartbeat_port = 43334 # Seconds how often the vitality of the Engine should be checked (0 = disabled) heartbeat_frequency = 1 ```