-
Notifications
You must be signed in to change notification settings - Fork 230
subparams
dinkypumpkin edited this page May 15, 2018
·
24 revisions
The following substitution parameters are available to certain options such as --command
and --fileprefix
. They are expanded into the corresponding values for the current programme begin recorded. Preview the values for a specific programme with --info
.
<available> = date/time made available (ISO8601 format)
<brand> = programme brand title
<channel> = programme channel
<credits> = downloaded programme credits file (if requested)
<desc> = brief description
<desclong> = long description
<descmedium> = medium description
<descshort> = short description
<dir> = directory of recorded file
<dldate> = date when the file was obtained in YYYY-MM-DD format
<dltime> = time when the file was obtained in HH:MM:SS format
<duration> = programme duration in seconds
<episode> = episode title (incl. episode number)
<episodenum> = episode number
<episodepart> = letter denoting part of multi-part episode
<episodeshort> = episode title with episode number stripped
<expires> = time when programme will expire (epoch format)
<ext> = filename extension of recorded file
<filename> = filename of recorded file
<filepart> = filename of partially recorded file
<fileprefix> = filename prefix for files associated with programme
<firstbcast> = date and time when programme was first broadcast
<firstbcastdate> = date portion of <firstbcast> in YYYY-MM-DD format
<firstbcastrel> = relative time when programme was first broadcast
<index> = index number (changes with every cache refresh)
<longname> = programme long name
<mode> = mode used to record programme
<name> = programme name
<nameshort> = programme name with series number stripped
<pid> = programme ID
<player> = programme URL
<rawaudio> = audio file produced with --raw from DASH TV streams
<rawvideo> = video file produced with --raw from DASH TV streams
<runtime> = programme runtime in minutes
<senum> = series and episode numbers in s##e## format (may be absent)
<series> = series title (may be absent)
<seriesnum> = series number
<subsfile> = downloaded subtitles file [SRT] (if requested)
<subsraw> = downloaded raw subtitles file [TTML] (if requested)
<thumbfile> = downloaded thumbnail file (if requested)
<thumbnail> = programme thumbnail URL
<timeadded> = time when programme was added to cache (epoch format)
<title> = programme full title
<tracklist> = downloaded track list file (if requested)
<type> = programme type: tv, radio
<verpids> = PIDs of available versions
<version> = selected version, e.g, 'signed'
<versions> = comma separated list of available versions
<web> = series URL