Plex-Meta-Manager/docs/defaults/both/audio_language.md

10 KiB
Raw Blame History

Audio Language Collections

The audio_language Default Metadata File is used to dynamically create collections based on the audio languages available in your library.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 10

Collection Key Description
Audio Language Collections separator Separator Collection to denote the Section of Collections.
<<Audio Language>> Audio
Example: Japanese
<<ISO 639-1 Code>>
Example: ja
Collection of Movies/Shows that have this Audio Language.
Other Audio other Collection of Movies/Shows that are less common Languages.

Config

The below YAML in your config.yml will create the collections:

libraries:
  Movies:
    metadata_path:
      - pmm: audio_language
  TV Shows:
    metadata_path:
      - pmm: audio_language

Template Variables

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.

Note that the template_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.

All Shared Collection Variables are available as well as the additional Variables below which can be used to customize the file.

This file contains a Separator so all Shared Separator Variables are available as well.

Variable Description & Values
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater then 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater then 0
sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option
sort_by_<<key>>1 Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option
include Description: Overrides the default include list
Values: List of ISO 639-1 codes
exclude Description: Exclude these Audio Languages from creating a Dynamic Collection.
Values: List of ISO 639-1 codes
append_include Description: Appends to the default include list
Values: List of ISO 639-1 codes
audio_language_name Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> Audio
Values: Any string with <<key_name>> in it.
audio_language_other_name Description: Changes the Other Collection name.
Default: Other Audio
Values: Any string.
audio_language_summary Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s filmed in the <<key_name>> Language.
Values: Any string.
audio_language_other_summary Description: Changes the Other Collection summary.
Default: <<library_translationU>>s filmed in other uncommon Languages.
Values: Any string.
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    metadata_path:
      - pmm: audio_language
        template_variables:
          use_other: false
          use_separator: false
          sep_style: purple
          exclude:
            - fr  # exclude French
          sort_by: title.asc

Default values

These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.

Default include

include:
  - ab     # Abkhazian
  - aa     # Afar
  - af     # Afrikaans
  - ak     # Akan
  - sq     # Albanian
  - am     # Amharic
  - ar     # Arabic
  - an     # Aragonese
  - hy     # Armenian
  - as     # Assamese
  - av     # Avaric
  - ae     # Avestan
  - ay     # Aymara
  - az     # Azerbaijani
  - bm     # Bambara
  - ba     # Bashkir
  - eu     # Basque
  - be     # Belarusian
  - bn     # Bengali
  - bi     # Bislama
  - bs     # Bosnian
  - br     # Breton
  - bg     # Bulgarian
  - my     # Burmese
  - ca     # Catalan, Valencian
  - km     # Central Khmer
  - ch     # Chamorro
  - ce     # Chechen
  - ny     # Chichewa, Chewa, Nyanja
  - zh     # Chinese
  - cu     # Church Slavic, Old Slavonic, Church Slavonic, Old Bulgarian, Old Church Slavonic
  - cv     # Chuvash
  - kw     # Cornish
  - co     # Corsican
  - cr     # Cree
  - hr     # Croatian
  - cs     # Czech
  - da     # Danish
  - dv     # Divehi, Dhivehi, Maldivian
  - nl     # Dutch, Flemish
  - dz     # Dzongkha
  - en     # English
  - eo     # Esperanto
  - et     # Estonian
  - ee     # Ewe
  - fo     # Faroese
  - fj     # Fijian
  - fil    # Filipino
  - fi     # Finnish
  - fr     # French
  - ff     # Fulah
  - gd     # Gaelic, Scottish Gaelic
  - gl     # Galician
  - lg     # Ganda
  - ka     # Georgian
  - de     # German
  - el     # Greek, Modern (1453)
  - gn     # Guarani
  - gu     # Gujarati
  - ht     # Haitian, Haitian Creole
  - ha     # Hausa
  - he     # Hebrew
  - hz     # Herero
  - hi     # Hindi
  - ho     # Hiri Motu
  - hu     # Hungarian
  - is     # Icelandic
  - io     # Ido
  - ig     # Igbo
  - id     # Indonesian
  - ia     # Interlingua (International Auxiliary Language Association)
  - ie     # Interlingue, Occidental
  - iu     # Inuktitut
  - ik     # Inupiaq
  - ga     # Irish
  - it     # Italian
  - ja     # Japanese
  - jv     # Javanese
  - kl     # Kalaallisut, Greenlandic
  - kn     # Kannada
  - kr     # Kanuri
  - ks     # Kashmiri
  - kk     # Kazakh
  - ki     # Kikuyu, Gikuyu
  - rw     # Kinyarwanda
  - ky     # Kirghiz, Kyrgyz
  - kv     # Komi
  - kg     # Kongo
  - ko     # Korean
  - kj     # Kuanyama, Kwanyama
  - ku     # Kurdish
  - lo     # Lao
  - la     # Latin
  - lv     # Latvian
  - li     # Limburgan, Limburger, Limburgish
  - ln     # Lingala
  - lt     # Lithuanian
  - lu     # Luba-Katanga
  - lb     # Luxembourgish, Letzeburgesch
  - mk     # Macedonian
  - mg     # Malagasy
  - ms     # Malay
  - ml     # Malayalam
  - mt     # Maltese
  - gv     # Manx
  - mi     # Maori
  - mr     # Marathi
  - mh     # Marshallese
  - mn     # Mongolian
  - na     # Nauru
  - nv     # Navajo, Navaho
  - ng     # Ndonga
  - ne     # Nepali
  - nd     # North Ndebele
  - se     # Northern Sami
  - no     # Norwegian
  - nb     # Norwegian Bokmål
  - nn     # Norwegian Nynorsk
  - oc     # Occitan
  - oj     # Ojibwa
  - or     # Oriya
  - om     # Oromo
  - os     # Ossetian, Ossetic
  - pi     # Pali
  - ps     # Pashto, Pushto
  - fa     # Persian
  - pl     # Polish
  - pt     # Portuguese
  - pa     # Punjabi, Panjabi
  - qu     # Quechua
  - ro     # Romanian, Moldavian, Moldovan
  - rm     # Romansh
  - rn     # Rundi
  - ru     # Russian
  - sm     # Samoan
  - sg     # Sango
  - sa     # Sanskrit
  - sc     # Sardinian
  - sr     # Serbian
  - sn     # Shona
  - ii     # Sichuan Yi, Nuosu
  - sd     # Sindhi
  - si     # Sinhala, Sinhalese
  - sk     # Slovak
  - sl     # Slovenian
  - so     # Somali
  - nr     # South Ndebele
  - st     # Southern Sotho
  - es     # Spanish, Castilian
  - su     # Sundanese
  - sw     # Swahili
  - ss     # Swati
  - sv     # Swedish
  - tl     # Tagalog
  - ty     # Tahitian
  - tg     # Tajik
  - ta     # Tamil
  - tt     # Tatar
  - te     # Telugu
  - th     # Thai
  - bo     # Tibetan
  - ti     # Tigrinya
  - to     # Tonga (Tonga Islands)
  - ts     # Tsonga
  - tn     # Tswana
  - tr     # Turkish
  - tk     # Turkmen
  - tw     # Twi
  - ug     # Uighur, Uyghur
  - uk     # Ukrainian
  - ur     # Urdu
  - uz     # Uzbek
  - ve     # Venda
  - vi     # Vietnamese
  - vo     # Volapük
  - wa     # Walloon
  - cy     # Welsh
  - fy     # Western Frisian
  - wo     # Wolof
  - xh     # Xhosa
  - yi     # Yiddish
  - yo     # Yoruba
  - za     # Zhuang, Chuang
  - zu     # Zulu