Commit 36da9578 authored by David Trattnig's avatar David Trattnig
Browse files

Added FAQ section.

parent 5628b6d4
...@@ -56,6 +56,7 @@ To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or ...@@ -56,6 +56,7 @@ To learn more, checkout the [Engine Developer Guide](docs/developer-guide.md) or
- [Developer Guide](docs/developer-guide.md) - [Developer Guide](docs/developer-guide.md)
- [Engine Features](docs/engine-features.md) - [Engine Features](docs/engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
## About ## About
......
...@@ -24,7 +24,6 @@ This page goes into detail on what is possible to configure within the engine. ...@@ -24,7 +24,6 @@ This page goes into detail on what is possible to configure within the engine.
- [Frequently Asked Questions](#frequently-asked-questions) - [Frequently Asked Questions](#frequently-asked-questions)
- [Which Audio Interface / Soundcard is compatible with Aura?](#which-audio-interface--soundcard-is-compatible-with-aura) - [Which Audio Interface / Soundcard is compatible with Aura?](#which-audio-interface--soundcard-is-compatible-with-aura)
- [ALSA Settings](#alsa-settings) - [ALSA Settings](#alsa-settings)
- [Install: I don't want to install all Liquidsoap Audio plugins. How?](#install-i-dont-want-to-install-all-liquidsoap-audio-plugins-how)
- [In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?](#in-the-liquidsoap-logs-i-get-error-when-starting-output-output_lineout_0-failureerror-while-setting-open_pcm-device-or-resource-busy-what-does-it-mean) - [In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?](#in-the-liquidsoap-logs-i-get-error-when-starting-output-output_lineout_0-failureerror-while-setting-open_pcm-device-or-resource-busy-what-does-it-mean)
- [How can I find the audio device IDs, required for settings in engine.ini?](#how-can-i-find-the-audio-device-ids-required-for-settings-in-engineini) - [How can I find the audio device IDs, required for settings in engine.ini?](#how-can-i-find-the-audio-device-ids-required-for-settings-in-engineini)
- [Read more](#read-more) - [Read more](#read-more)
...@@ -168,20 +167,6 @@ Engine has been tested with following audio interfaces: ...@@ -168,20 +167,6 @@ Engine has been tested with following audio interfaces:
### ALSA Settings ### ALSA Settings
#### Install: I don't want to install all Liquidsoap Audio plugins. How?
Depending on what stream you are going to send, and what recordings you are going to use,
install one or some of the following:
```bash
sudo apt install \
liquidsoap-plugin-aac # for aac support
liquidsoap-plugin-flac # for flac support
liquidsoap-plugin-lame liquidsoap-plugin-mad # for mp3 support
liquidsoap-plugin-opus # for opus support
liquidsoap-plugin-vorbis # for ogg support
```
#### In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean? #### In the Liquidsoap Logs I get 'Error when starting output output_lineout_0: Failure("Error while setting open_pcm: Device or resource busy")!'. What does it mean?
You probably have set a wrong or occupied device ID. You probably have set a wrong or occupied device ID.
...@@ -225,3 +210,4 @@ Well, this is - at least for me - a hard one. I could not manage to find correct ...@@ -225,3 +210,4 @@ Well, this is - at least for me - a hard one. I could not manage to find correct
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -137,3 +137,4 @@ Push some audio file to the filesystem `queue 0` ...@@ -137,3 +137,4 @@ Push some audio file to the filesystem `queue 0`
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -123,7 +123,6 @@ schemas: ...@@ -123,7 +123,6 @@ schemas:
* `/api/v1/schedule/upcoming` .. Returns the next three schedules, after the one currently playing. * `/api/v1/schedule/upcoming` .. Returns the next three schedules, after the one currently playing.
```yaml ```yaml
schemas: schemas:
Schedule: Schedule:
...@@ -143,12 +142,10 @@ schemas: ...@@ -143,12 +142,10 @@ schemas:
openapi: 3.0.2 openapi: 3.0.2
``` ```
**Clock API**: Retrieve all data relevant for a studio clock. **Clock API**: Retrieve all data relevant for a studio clock.
* `/api/v1/clock` .............. Returns the current show, next show, playlist and time left until the next show. * `/api/v1/clock` .............. Returns the current show, next show, playlist and time left until the next show.
```yaml ```yaml
schemas: schemas:
Clock: Clock:
...@@ -165,13 +162,11 @@ schemas: ...@@ -165,13 +162,11 @@ schemas:
openapi: 3.0.2 openapi: 3.0.2
``` ```
## Web Applications ## Web Applications
* `/app/trackservice` ................. Web Application for displaying the Track-Service * `/app/trackservice` ................. Web Application for displaying the Track-Service
* `/app/clock` ........................ Web Application for displaying the studio clock * `/app/clock` ........................ Web Application for displaying the studio clock
## Read more ## Read more
- [Overview](/README.md) - [Overview](/README.md)
...@@ -182,4 +177,4 @@ schemas: ...@@ -182,4 +177,4 @@ schemas:
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
# Frequently Asked Questions
<!-- TOC -->
- [Frequently Asked Questions](#frequently-asked-questions)
- [Starting Engine](#starting-engine)
- [Read More](#read-more)
<!-- /TOC -->
## Starting Engine
**Error when starting output lineout: Failure("Error while setting open_pcm: No such file or directory**
This might indicate some issue with your ALSA device. Check if `aplay -l` and `aplay -L` returns some valid device(s).
## Read More
- [Overview](/README.md)
- [Installation for Development](installation-development.md)
- [Installation for Production](installation-production.md)
- [Running with Docker](running-docker.md)
- [Setup the Audio Store](docs/setup-audio-store.md)
- [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -208,3 +208,4 @@ All Engine logs for development can be found under `./logs`. ...@@ -208,3 +208,4 @@ All Engine logs for development can be found under `./logs`.
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -323,3 +323,4 @@ Additionally you'll finde Supervisor specific logs under: ...@@ -323,3 +323,4 @@ Additionally you'll finde Supervisor specific logs under:
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -57,3 +57,4 @@ This section is only relevant if you are an Engine Developer. ...@@ -57,3 +57,4 @@ This section is only relevant if you are an Engine Developer.
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
...@@ -145,3 +145,4 @@ this file. Then restart your Tank Docker container and you should be good to go. ...@@ -145,3 +145,4 @@ this file. Then restart your Tank Docker container and you should be good to go.
- [Configuration Guide](configuration-guide.md) - [Configuration Guide](configuration-guide.md)
- [Developer Guide](developer-guide.md) - [Developer Guide](developer-guide.md)
- [Engine Features](engine-features.md) - [Engine Features](engine-features.md)
- [Frequently Asked Questions (FAQ)](docs/frequently-asked-questions.md)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment