5e9472986a
Enhances the music video presets by supporting the following syntax:
`subscriptions.yaml`
```
__preset__:
overrides:
music_video_directory: "/music_videos"
# Choose between Jellyfin/Kodi/Plex Music Videos preset:
# - Plex Music Videos:
# - Jellyfin Music Videos:
# - Kodi Music Videos:
#
"Plex Music Videos":
= Pop: # Sets genre tag to "Pop"
"Rick Astley": "https://www.youtube.com/playlist?list=PLlaN88a7y2_plecYoJxvRFTLHVbIVAOoc"
"Michael Jackson": "https://www.youtube.com/playlist?list=OLAK5uy_mnY03zP6abNWH929q2XhGzWD_2uKJ_n8E"
= Rock:
# Prefixing with '+' puts the subscription into 'map-mode'.
# Music video presets in map-mode support grouping videos into different
# categories, which get set on the album field.
#
# URLs can either be strings, or maps that can overload title, year, date
"+ Guns N' Roses":
Music Videos:
- "https://www.youtube.com/playlist?list=PLOTK54q5K4INNXaHKtmXYr6J7CajWjqeJ"
Concerts:
- title: "Live at The Ritz - New York City"
year: "1988"
url: "https://www.youtube.com/watch?v=OldpIhHPsbs"
- title: "Live at The Hollywood Bowl"
date: "2023-01-11"
url: "https://www.youtube.com/watch?v=Z7hutGlvq9I"
```
The 'map-mode' (denoted by `+`) lets you specify a map of music video categories. Under each category, a URL can be specified as-is or with additional metadata (title, year/date, url).
Music videos and concerts, especially older ones, are typically uploaded by random users with inconsistencies in their titles. This syntax aims to make it easy to specify individual URLs with the ability to overwrite their title and year, and group them by category.
91 lines
2 KiB
ReStructuredText
91 lines
2 KiB
ReStructuredText
|
|
Static Variables
|
|
================
|
|
|
|
Subscription Variables
|
|
----------------------
|
|
|
|
subscription_array
|
|
~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name":
|
|
- "https://url1.com/..."
|
|
- "https://url2.com/..."
|
|
|
|
Store all values into an array named ``subscription_array``.
|
|
|
|
subscription_has_download_archive
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Returns True if the subscription has any entries recorded in a download archive. False
|
|
otherwise.
|
|
|
|
subscription_indent_i
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
Preset | = Indent Value 1:
|
|
= Indent Value 2:
|
|
"Subscription Name": "https://..."
|
|
|
|
``subscription_indent_1`` and ``subscription_indent_2`` get set to
|
|
``Indent Value 1`` and ``Indent Value 2``.
|
|
|
|
subscription_map
|
|
~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
+ Subscription Name:
|
|
Music Videos:
|
|
- "https://url1.com/..."
|
|
Concerts:
|
|
- "https://url2.com/..."
|
|
|
|
Stores all the contents under the subscription name into the override variable
|
|
``subscription_map`` as a Map value. The above example is stored as:
|
|
|
|
.. code-block:: python
|
|
|
|
{
|
|
"Music Videos": [
|
|
"https://url1.com/..."
|
|
],
|
|
"Concerts: [
|
|
"https://url2.com/..."
|
|
]
|
|
}
|
|
|
|
subscription_name
|
|
~~~~~~~~~~~~~~~~~
|
|
Name of the subscription. For subscriptions types that use a prefix (``~``, ``+``),
|
|
the prefix and all whitespace afterwards is stripped from the subscription name.
|
|
|
|
subscription_value
|
|
~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name": "https://..."
|
|
|
|
``subscription_value`` gets set to ``https://...``.
|
|
|
|
subscription_value_i
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
For subscriptions in the form of
|
|
|
|
.. code-block:: yaml
|
|
|
|
"Subscription Name":
|
|
- "https://url1.com/..."
|
|
- "https://url2.com/..."
|
|
|
|
``subscription_value_1`` and ``subscription_value_2`` get set to ``https://url1.com/...``
|
|
and ``https://url2.com/...``. Note that ``subscription_value_1`` also gets set to
|
|
``subscription_value``.
|