Reference

This section contains direct references to the code of ytdl-sub and information on how it functions.

• Configuration File
  • config.yaml
    • configuration
      • ConfigOptions
        • ConfigOptions.working_directory
        • ConfigOptions.umask
        • ConfigOptions.dl_aliases
        • ConfigOptions.file_name_max_bytes
        • ConfigOptions.lock_directory
        • ConfigOptions.ffmpeg_path
        • ConfigOptions.ffprobe_path
      • persist_logs
        • PersistLogsValidator
          • PersistLogsValidator.logs_directory
          • PersistLogsValidator.keep_successful_logs
    • presets
      • preset
• Subscriptions File
  • subscriptions.yaml
    • Beautifying Subscriptions
    • File Preset
    • Subscription Value
• Plugins
  • audio_extract
  • chapters
  • date_range
  • download
  • embed_thumbnail
  • file_convert
  • filter_exclude
  • filter_include
  • format
  • match_filters
  • music_tags
  • nfo_tags
  • output_directory_nfo_tags
  • output_options
  • overrides
  • regex
  • split_by_chapters
  • subtitles
  • throttle_protection
  • video_tags
  • ytdl_options
• Scripting
  • Entry Variables
    • Entry Variables
      • channel
      • channel_id
      • chapters
      • comments
      • creator
      • description
      • duration
      • epoch
      • epoch_date
      • epoch_hour
      • ext
      • extractor
      • extractor_key
      • ie_key
      • info_json_ext
      • requested_subtitles
      • sponsorblock_chapters
      • thumbnail_ext
      • title
      • title_sanitized_plex
      • uid
      • uid_sanitized_plex
      • uploader
      • uploader_id
      • uploader_url
      • webpage_url
    • Metadata Variables
      • entry_metadata
      • playlist_metadata
      • sibling_metadata
      • source_metadata
    • Playlist Variables
      • playlist_count
      • playlist_description
      • playlist_index
      • playlist_index_padded
      • playlist_index_padded6
      • playlist_index_reversed
      • playlist_index_reversed_padded
      • playlist_index_reversed_padded6
      • playlist_max_upload_date
      • playlist_max_upload_year
      • playlist_max_upload_year_truncated
      • playlist_title
      • playlist_uid
      • playlist_uploader
      • playlist_uploader_id
      • playlist_uploader_url
      • playlist_webpage_url
    • Release Date Variables
      • release_date
      • release_date_standardized
      • release_day
      • release_day_of_year
      • release_day_of_year_padded
      • release_day_of_year_reversed
      • release_day_of_year_reversed_padded
      • release_day_padded
      • release_day_reversed
      • release_day_reversed_padded
      • release_month
      • release_month_padded
      • release_month_reversed
      • release_month_reversed_padded
      • release_year
      • release_year_truncated
      • release_year_truncated_reversed
    • Source Variables
      • source_count
      • source_description
      • source_index
      • source_index_padded
      • source_title
      • source_uid
      • source_uploader
      • source_uploader_id
      • source_uploader_url
      • source_webpage_url
    • Upload Date Variables
      • upload_date
      • upload_date_standardized
      • upload_day
      • upload_day_of_year
      • upload_day_of_year_padded
      • upload_day_of_year_reversed
      • upload_day_of_year_reversed_padded
      • upload_day_padded
      • upload_day_reversed
      • upload_day_reversed_padded
      • upload_month
      • upload_month_padded
      • upload_month_reversed
      • upload_month_reversed_padded
      • upload_year
      • upload_year_truncated
      • upload_year_truncated_reversed
    • Ytdl-Sub Variables
      • download_index
      • download_index_padded6
      • upload_date_index
      • upload_date_index_padded
      • upload_date_index_reversed
      • upload_date_index_reversed_padded
      • ytdl_sub_input_url
      • ytdl_sub_input_url_count
      • ytdl_sub_input_url_index
  • Static Variables
    • Subscription Variables
      • subscription_has_download_archive
      • subscription_indent_i
      • subscription_map
      • subscription_name
      • subscription_value
      • subscription_value_i
  • Scripting Functions
    • Array Functions
      • array
      • array_apply
      • array_apply_fixed
      • array_at
      • array_contains
      • array_enumerate
      • array_extend
      • array_first
      • array_flatten
      • array_index
      • array_overlay
      • array_product
      • array_reduce
      • array_reverse
      • array_size
      • array_slice
    • Boolean Functions
      • and
      • bool
      • eq
      • gt
      • gte
      • is_array
      • is_bool
      • is_float
      • is_int
      • is_map
      • is_null
      • is_numeric
      • is_string
      • lt
      • lte
      • ne
      • not
      • or
      • xor
    • Conditional Functions
      • elif
      • if
      • if_passthrough
    • Date Functions
      • datetime_strftime
    • Error Functions
      • assert
      • assert_eq
      • assert_ne
      • assert_then
      • throw
    • Json Functions
      • from_json
    • Map Functions
      • map
      • map_apply
      • map_contains
      • map_enumerate
      • map_extend
      • map_get
      • map_get_non_empty
      • map_size
    • Numeric Functions
      • add
      • div
      • float
      • int
      • max
      • min
      • mod
      • mul
      • pow
      • sub
    • Regex Functions
      • regex_capture_groups
      • regex_fullmatch
      • regex_match
      • regex_search
      • regex_sub
    • String Functions
      • capitalize
      • concat
      • contains
      • lower
      • pad
      • pad_zero
      • replace
      • slice
      • split
      • string
      • titlecase
      • upper
    • Ytdl-Sub Functions
      • legacy_bracket_safety
      • sanitize
      • sanitize_plex_episode
      • to_date_metadata
      • to_native_filepath
      • truncate_filepath_if_too_long
  • Scripting Types
    • Types
      • String
      • Integer
      • Float
      • Boolean
      • Array
      • Map
      • Null
    • Function Type-Hints
      • AnyArgument
      • Numeric
      • Optional
      • Lambda
      • LambdaReduce
      • ReturnableArguments
  • How it Works
    • Static String
    • Static Variables
    • Entry Variables
    • Creating Custom Variables
    • Sanitizing Variables
    • Using Scripting Functions
  • Advanced Scripting
    • Accessing info.json Fields
    • Creating Custom Functions
• Prebuilt Preset Reference
  • Common
    • Media Quality
    • Only Recent Videos
  • TV Show
  • Music