You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
2.9 KiB
76 lines
2.9 KiB
2 years ago
|
# Audio Language Overlay
|
||
2 years ago
|
|
||
2 years ago
|
The `audio_language` Default Overlay File is used to create an overlay based on the number of audio languages available on each item within your library.
|
||
2 years ago
|
|
||
2 years ago
|
**This file works with Movie and Show Libraries.**
|
||
2 years ago
|
|
||
2 years ago
|
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme**
|
||
|
|
||
|
![](images/audio_language.png)
|
||
|
|
||
|
## Supported Audio Languages
|
||
|
|
||
|
| Audio Codec | Key | Weight |
|
||
|
|:------------|:-------:|:------:|
|
||
|
| Dual | `dual` | `20` |
|
||
|
| Multi | `multi` | `10` |
|
||
|
|
||
|
## Config
|
||
2 years ago
|
|
||
|
The below YAML in your config.yml will create the overlays:
|
||
2 years ago
|
|
||
2 years ago
|
```yaml
|
||
|
libraries:
|
||
|
Movies:
|
||
|
overlay_path:
|
||
|
- pmm: audio_language
|
||
2 years ago
|
TV Shows:
|
||
|
overlay_path:
|
||
|
- pmm: audio_language
|
||
|
- pmm: audio_language
|
||
|
template_variables:
|
||
|
overlay_level: season
|
||
|
- pmm: audio_language
|
||
|
template_variables:
|
||
|
overlay_level: episode
|
||
2 years ago
|
```
|
||
|
|
||
|
## Template Variables
|
||
|
|
||
2 years ago
|
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||
2 years ago
|
|
||
2 years ago
|
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||
2 years ago
|
|
||
2 years ago
|
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
|
||
2 years ago
|
|
||
2 years ago
|
| Variable | Default |
|
||
|
|:--------------------|:-----------:|
|
||
|
| `horizontal_offset` | `0` |
|
||
|
| `horizontal_align` | `center` |
|
||
|
| `vertical_offset` | `30` |
|
||
|
| `vertical_align` | `bottom` |
|
||
|
| `back_color` | `#00000099` |
|
||
|
| `back_radius` | `30` |
|
||
|
| `back_width` | `188` |
|
||
|
| `back_height` | `105` |
|
||
2 years ago
|
|
||
2 years ago
|
| Variable | Description & Values |
|
||
|
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------|
|
||
|
| `minimum` | **Description:** Choose the minimum for the `multi` Overlay.<br>**Default:** `2` <br>**Values:** Any Number |
|
||
|
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||
2 years ago
|
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||
|
|
||
|
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||
2 years ago
|
|
||
2 years ago
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||
2 years ago
|
|
||
2 years ago
|
```yaml
|
||
|
libraries:
|
||
|
Movies:
|
||
|
overlay_path:
|
||
|
- pmm: audio_codec
|
||
|
template_variables:
|
||
|
use_opus: false
|
||
|
use_mp3: false
|
||
|
```
|