Static Variables

Static Variables#

Subscription Variables#

subscription_array#

For subscriptions in the form of

"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 where the ancestor keys contain the = ... prefix, the variables subscription_indent_1, subscription_indent_2, and so on get set to each subsequent value. For example, given the following subscriptions file snippet:

Preset 1 | = Indent Value 1 | Preset 2:
  Preset 3 | = Indent Value 2 | Preset 4:
    "Subscription Name": "https://..."

The {subscription_indent_1} variable will be Indent Value 1 and {subscription_indent_2} will be Indent Value 2. The most common use of these variables is to set the genre and rating for subscriptions from the YAML keys.

subscription_map#

For subscriptions in the form of

+ 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:

{
  "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

"Subscription Name": "https://..."

subscription_value gets set to https://....

subscription_value_i#

For subscriptions in the form of

"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.