get_iplayer man page

get_iplayer — Stream Recording tool and PVR for BBC iPlayer, BBC Podcasts and more

Synopsis

get_iplayer [<options>] [<regex|index> ...]

get_iplayer --get [<options>] <regex|index> ...
get_iplayer <url> --type=<type> [<options>]

get_iplayer <pid|url> [--type=<type> <options>]

get_iplayer --stream [<options>] <regex|index> | mplayer -cache 3072 -

get_iplayer --stream [<options>] --type=<type> <pid|url> | mplayer -cache 3072 -

get_iplayer --stream [<options>] --type=livetv,liveradio <regex|index> --player="mplayer -cache 128 -"

get_iplayer --refresh

Description

get_iplayer lists, searches and records BBC iPlayer TV/Radio, BBC Podcast programmes. Other 3rd-Party plugins may be available.

get_iplayer has three modes: recording a complete programme for later playback, streaming a programme directly to a playback application, such as mplayer; and as a Personal Video Recorder (PVR), subscribing to search terms and recording programmes automatically. It can also stream or record live BBC iPlayer output

If given no arguments, get_iplayer updates and displays the list of currently available programmes. Each available programme has a numerical identifier, pid. get_iplayer utilises the rtmpdump tool to record BBC iPlayer programmes from RTMP flash streams at various qualities.

In PVR mode, get_iplayer can be called from cron to record programmes to a schedule.

Options

Search Options

--available-since <hours>
Limit search to programmes that have become available in the last N hours
--before <hours>
Limit search to programmes added to the cache before N hours ago
--channel <string>
Narrow search to matched channel(s) (regex or comma separated values)
--exclude <string>
Narrow search to exclude matched programme names (regex or comma separated values)
--exclude-channel <string>
Narrow search to exclude matched channel(s) (regex or comma separated values)
--expires-before <hours>
Limit search to programmes that will expire in the next N hours
--fields <field1>,<field2>,..
Searches only in the specified comma separated fields
--future
Additionally search future programme schedule if it has been indexed (refresh cache with: --refresh --refresh-future).
--history
Search/show recordings history
--long, -l
Additionally search in programme descriptions and episode names (same as --fields=name,episode,desc )
--search <search term>
GetOpt compliant way of specifying search args
--since <hours>
Limit search to programmes added to the cache in the last N hours
--type <type>
Only search in these types of programmes: liveradio,livetv,localfiles,podcast,radio,tv,all (tv is default)

Display Options

--conditions
Shows GPLv3 conditions
--debug
Debug output
--dump-options
Dumps all options with their internal option key names
--help, -h
Intermediate help text
--helpbasic, --usage
Basic help text
--helplong
Advanced help text
--hide
Hide previously recorded programmes
--info, -i
Show full programme metadata and availability of modes and subtitles (max 40 matches)
--listformat <format>
Display programme data based on a user-defined format string (such as <pid>, <name> etc)
--long, -l
Show long programme info
--manpage <file>
Create man page based on current help text
--nocopyright
Don't display copyright header
--page <number>
Page number to display for multipage output
--pagesize <number>
Number of matches displayed on a page for multipage output
--quiet, -q
Reduce logging output
--show-cache-age
Displays the age of the selected programme caches then exit
--show-options
Shows options which are set and where they are defined
--silent
No logging output except PVR download report. Cannot be saved in preferences or PVR searches.
--sort <fieldname>
Field to use to sort displayed matches
--sortreverse
Reverse order of sorted matches
--streaminfo
Returns all of the media stream urls of the programme(s)
--verbose, -v
Verbose
--warranty
Displays warranty section of GPLv3
-V
Show get_iplayer version and exit.

Recording Options

--attempts <number>
Number of attempts to make or resume a failed connection. --attempts is applied per-stream, per-mode. TV modes typically have two streams available.
--exclude-supplier <suppliers>
Comma-delimited list of media stream suppliers to skip. Possible values: level3,akamai,limelight,bidi
--force
Ignore programme history (unsets --hide option also). Forces a script update if used with -u
--get, -g
Start recording matching programmes. Search terms required unless --pid specified. Use --search=.* to force download of all available programmes.
--hash
Show recording progress as hashes
--include-supplier <suppliers>
Comma-delimited list of media stream suppliers to use if not included by default. Possible values: level3,akamai,limelight,bidi
--metadata-only
Create specified metadata info file without any recording or streaming (can also be used with thumbnail option).
--modes <mode>,<mode>,...
Recording modes. See --tvmode and --radiomode (with --long-help) for available modes and defaults. Shortcuts: tvworst,tvworse,tvgood,tvvgood,tvbetter,tvbest,radioworst,radioworse,radiogood,radiovgood,radiobetter,radiobest (default=default for programme type).
--no-proxy
Ignore --proxy setting in preferences
--overwrite
Overwrite recordings if they already exist
--partial-proxy
Only uses web proxy where absolutely required (try this extra option if your proxy fails). If specified, value of http_proxy environment variable (if any) in parent process is retained and passed to child processes.
--pid <pid>
Record an arbitrary PID that does not necessarily appear in the index.
--pid-recursive
Record all related episodes if value of --pid is a series or brand PID. Requires --pid.
--pid-recursive-noclips
When used with --pid and --pid-recursive, skip all associated programme clips if the value of --pid is a brand PID. Requires --pid and --pid-recursive.
--proxy, -p <url>
Web proxy URL e.g. 'http://USERNAME:PASSWORD@SERVER:PORT' or 'http://SERVER:PORT'. Sets http_proxy environment variable for child processes (e.g., ffmpeg) unless --partial-proxy is specified.
--radiomode <mode>,<mode>,...
Radio recording modes (overrides --modes): dashhigh,dashstd,dashmed,dashlow,flashaachigh,flashaacstd,flashaaclow,hafhigh,hafstd,hafmed,haflow,hlsaacstd,hlsaaclow. Shortcuts: worst,worse,good,vgood,better,best,dash,flashaac,haf,hlsaac (default=dashhigh,hafhigh,dashstd,hafstd,hlsaacstd,dashmed,hafmed,dashlow,haflow,hlsaaclow).
--raw
Don't transcode or change the recording/stream in any way (i.e. RTMP->FLV, HLS->MPEG-TS)
--start <secs|hh:mm:ss>
Recording/streaming start offset (actual start may be several seconds earlier for HLS and DASH streams)
--stop <secs|hh:mm:ss>
Recording/streaming stop offset (actual stop may be several seconds later for HLS and DASH streams)
--suboffset <offset>
Offset the subtitle timestamps by the specified number of milliseconds
--subsfmt <format>
Subtitles format. One of: default, compact. Default: 'default'
--subsraw
Additionally save the raw subtitles file
--subtitles
Download subtitles into srt/SubRip format if available and supported
--subtitles-only
Only download the subtitles, not the programme
--subtitles-required
Do not download TV programme if subtitles are not available.
--tag-only
Only update the programme metadata tag and not download the programme (can also be used with --history)
--tag-only-filename <filename>
Add metadata tags to specified file (ignored unless used with --tag-only)
--test, -t
Test only - no recording (will show programme type)
--thumb
Download Thumbnail image if available
--thumbnail-only
Only Download Thumbnail image if available, not the programme
--tvmode <mode>,<mode>,...
TV recording modes (overrides --modes): flashhd,flashvhigh,flashhigh,flashstd,flashnormal,flashlow,hlshd,hlsvhigh,hlshigh,hlsstd,hlslow,hvfhd,hvfsd,hvfvhigh,hvfhigh,hvfstd,hvflow. Shortcuts: worst,worse,vgood,better,best,flash,hls,hvf (default=hvfhd,hlshd,hvfsd,hvfvhigh,hlsvhigh,hvfhigh,hlshigh,hvfstd,hlsstd,hvflow,hlslow).
--url "<url>"
Record the embedded media player in the specified URL. Use with --type=<type>.
--versions <versions>
Version of programme to record. List is processed from left to right and first version found is downloaded. Example: '--versions=audiodescribed,default' will prefer audiodescribed programmes if available.

Output Options

--command, -c <command>
Run user command after successful recording using args such as <pid>, <name> etc
--file-prefix <format>
The filename prefix (excluding dir and extension) using formatting fields. e.g. '<name>-<episode>-<pid>'
--metadata <type>
Create metadata info file after recording. Valid types are: xbmc (or kodi), xbmc_movie (or kodi_movie), freevo, generic
--output, -o <dir>
Recording output directory
--outputradio <dir>
Output directory for radio recordings (overrides --output)
--outputtv <dir>
Output directory for tv recordings (overrides --output)
--subdir, -s
Put Recorded files into Programme name subdirectory
--subdir-format <format>
The format to be used for the subdirectory naming using formatting fields. e.g. '<nameshort>-<seriesnum>'
--thumbsize <index|width>
Default thumbnail size/index to use for the current recording and metadata. index: 1-11 or width: 86,150,178,512,528,640,832,1024,1280,1600,1920
--thumbsizecache <index|width>
Default thumbnail size/index to use when building cache. index: 1-11 or width: 86,150,178,512,528,640,832,1024,1280,1600,1920
--whitespace, -w
Keep whitespace in file and directory names. Default behaviour is to replace whitespace with underscores.

PVR Options

--comment <string>
Adds a comment to a PVR search
--pvr [pvr search name]
Runs the PVR using all saved PVR searches (intended to be run every hour from cron etc). The list can be limited by adding a regex to the command. Synonyms: --pvrrun, --pvr-run
--pvr-add <search name>
Save the named PVR search with the specified search terms. Search terms required. Use --search=.* to force download of all available programmes. Synonyms: --pvradd
--pvr-del <search name>
Remove the named search from the PVR searches. Synonyms: --pvrdel
--pvr-disable <search name>
Disable (not delete) a named PVR search. Synonyms: --pvrdisable
--pvr-enable <search name>
Enable a previously disabled named PVR search. Synonyms: --pvrenable
--pvr-exclude <string>
Exclude the PVR searches to run by search name (regex or comma separated values). Synonyms: --pvrexclude
--pvr-list
Show the PVR search list. Synonyms: --pvrlist
--pvr-queue
Add currently matched programmes to queue for later one-off recording using the --pvr option. Search terms required unless --pid specified. Synonyms: --pvrqueue
--pvr-scheduler <seconds>
Runs the PVR using all saved PVR searches every <seconds>. Synonyms: --pvrscheduler
--pvr-single <search name>
Runs a named PVR search. Synonyms: --pvrsingle

Config Options

--cache-reset
Reset cache to retain only latest update and discard previous contents.
--expiry, -e <secs>
Cache expiry in seconds (default 4hrs)
--limit-matches <number>
Limits the number of matching results for any search (and for every PVR search)
--nopurge
Don't ask to delete programmes recorded over 30 days ago
--prefs-add
Add/Change specified saved user or preset options
--prefs-clear
Remove *ALL* saved user or preset options
--prefs-del
Remove specified saved user or preset options
--prefs-show
Show saved user or preset options
--preset, -z <name>
Use specified user options preset
--preset-list
Show all valid presets
--profile-dir <dir>
Override the user profile directory/folder
--refresh, --flush, -f
Refresh cache
--refresh-exclude <string>
Exclude matched channel(s) when refreshing cache (regex or comma separated values). Overrides --refresh-include-groups[-{tv,radio}] status for specified channel(s)
--refresh-exclude-groups
Exclude channel groups when refreshing radio or tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--refresh-exclude-groups-radio
Exclude channel groups when refreshing radio cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--refresh-exclude-groups-tv
Exclude channel groups when refreshing tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--refresh-future
Obtain future programme schedule when refreshing cache
--refresh-include <string>
Include matched channel(s) when refreshing cache (regex or comma separated values). Overrides --refresh-exclude-groups[-{tv,radio}] status for specified channel(s)
--refresh-include-groups
Include channel groups when refreshing radio or tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--refresh-include-groups-radio
Include channel groups when refreshing radio cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--refresh-include-groups-tv
Include channel groups when refreshing tv cache (comma-separated values). Valid values: 'national', 'regional', 'local'
--skipdeleted
Skip the download of metadata/thumbs/subs if the media file no longer exists. Use with --history & --metadataonly/subsonly/thumbonly.
--webrequest <urlencoded string>
Specify all options as a urlencoded string of "name=val&name=val&..."

External Program Options

--atomicparsley <path>
Location of AtomicParsley binary
--ffmpeg <path>
Location of ffmpeg binary.
--ffmpeg-obsolete
Indicates you are using an obsolete version of ffmpeg (<0.7) that does not support the -loglevel or -stats options, so --quiet, --verbose and --debug will not be applied to ffmpeg.

Tagging Options

--no-artwork
Do not embed thumbnail image in output file. Also removes existing artwork. All other metadata values will be written.
--no-tag
Do not tag downloaded programmes
--tag-format-show
Format template for programme name in metadata (use substitution parameters). Default: none
--tag-format-title
Format template for episode title in metadata (use substitution parameters). Default: none
--tag-isodate
Use ISO8601 dates (YYYY-MM-DD) in album/show names and track titles
--tag-podcast
Tag downloaded radio and tv programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)
--tag-podcast-radio
Tag only downloaded radio programmes as iTunes podcasts (requires MP3::Tag module for AAC/MP3 files)
--tag-podcast-tv
Tag only downloaded tv programmes as iTunes podcasts
--tag-utf8
Use UTF-8 encoding for non-ASCII characters in AtomicParsley parameter values (Linux/Unix/OS X only). Use only if auto-detect fails.

Misc Options

--encoding-console-in <name>
Character encoding for standard input (currently unused). Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp850
--encoding-console-out <name>
Character encoding used to encode search results and other output. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp850
--encoding-locale <name>
Character encoding used to decode command-line arguments. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp1252
--encoding-locale-fs <name>
Character encoding used to encode file and directory names. Encoding name must be known to Perl Encode module. Default (only if auto-detect fails): Linux/Unix/OSX = UTF-8, Windows = cp1252
--index-concurrent
Perform fork()-based concurrent (i.e., faster) indexing when web scraping TV schedules only. Requires --ybbcy and Parallel::ForkManager Perl module. Not supported on Windows.
--index-maxconn <number>
Maximum number of forks (connections) to use for concurrent indexing. Requires --index-concurrent. Default: 4 Max: 10
--no-scrape-versions
Do not scrape episode web pages as extra measure to find audiodescribed/signed versions.
--trim-history <# days to retain>
Remove download history entries older than number of days specified in option value. Cannot specify 0 - use 'all' to completely delete download history
--ybbcy
Use alternate programme indexing and metadata retrieval if the BBC removes its XML data sources. TV programme indexing will be extremely slow. Some metadata will be missing or incorrect.

Deprecated Options

--aactomp3
Transcode AAC audio to MP3 with ffmpeg (CBR appropriate for mode unless --mp3vbr is specified). Applied only to radio programmes. (Synonyms: --mp3)
--avi
Output video in AVI container instead of MP4. There is no metadata tagging support for AVI output.
--category <string>
Narrow search to matched categories (regex or comma separated values). Supported only for podcasts (not tv or radio programmes).
--check-duration
Print message showing recorded duration, expected duration and difference between them. Ignored when recording live streams.
--email <address>
Email HTML index of matching programmes to specified address
--email-password <password>
Email password
--email-port <port number>
Email port number (default: appropriate port for --email-security)
--email-security <TLS|SSL>
Email security TLS, SSL (default: none)
--email-sender <address>
Optional email sender address
--email-smtp <hostname>
SMTP server IP address to use to send email (default: localhost)
--email-user <username>
Email username
--exclude-category <string>
Narrow search to exclude matched categories (regex or comma separated values). Supported only for podcasts (not tv or radio programmes).
--fatfilename
Remove FAT forbidden characters in file and directory names. Always applied on Windows. Overrides --punctuation.
--ffmpeg-liveradio-opts <options>
Add custom options to ffmpeg re-muxing for liveradio
--ffmpeg-livetv-opts <options>
Add custom options to ffmpeg re-muxing for livetv
--ffmpeg-radio-opts <options>
Add custom options to ffmpeg re-muxing for radio
--ffmpeg-tv-opts <options>
Add custom options to ffmpeg re-muxing for tv
--fxd <file>
Create Freevo FXD XML of matching programmes in specified file
--hfsfilename
Remove colons in file and directory names. Prevents OS X Finder displaying colon as forward slash. Always applied on OS X. Overrides --punctuation.
--hls-ffmpeg
Use ffmpeg instead of built-in HLS downloader. Ignored for downloading on-demand radio programmes, which use DASH downloader. 320k on-demand radio programmes cannot be streamed with --hls-ffmpeg.
--hls-ffmpeg-encode
Make ffmpeg HLS downloader re-encode streams. For old versions of ffmpeg (<2.5). May record slower than real time and may not be able to stream higher-quality media.
--hls-liveradio-opts <options>
Add custom options to ffmpeg HLS download re-muxing for liveradio
--hls-livetv-opts <options>
Add custom options to ffmpeg HLS download encoding for livetv
--hls-radio-opts <options>
Add custom options to ffmpeg HLS download re-muxing for radio
--hls-tv-opts <options>
Add custom options to ffmpeg HLS download re-muxing for tv
--html <file>
Create basic HTML index of matching programmes in specified file
--id3v2 <path>
Location of id3v2 or id3tag binary
--isodate
Use ISO8601 dates (YYYY-MM-DD) in filenames and subdirectory paths. Default: true
--keep-all
Keep whitespace, all possible punctuation and non-ASCII characters in file and directory names. Shortcut for: --whitespace --non-ascii --punctuation.
--list <categories|channel>
Show a list of available categories/channels for the selected type and exit
--listplugins
Display a list of currently available plugins or programme types
--liveradio-intl
Force use of hard-coded international streams for HLS live radio. Ignored for World Service
--liveradio-uk
Force use of hard-coded UK streams for HLS live radio (overrides --liveradio-intl). Ignored for World Service
--liveradiomode <mode>,<mode>,..
Live Radio recording modes (overrides --modes): hafhigh,hafstd,hafmed,haflow,shoutcastmp3std,shoutcastaachigh (R3 only, UK only). Shortcuts: worst,worse,good,vgood,better,best,haf,shoutcast. (default=hafhigh,hafstd,hafmed,haflow)
--livetvmode <mode>,<mode>,...
Live TV recording modes (overrides --modes): hvfhd,hvfsd,hvfvhigh,hvfhigh,hvfstd,hvflow. Shortcuts: worst,worse,good,vgood,better,best,hvf. (default=hvfhd,hvfsd,hvfvhigh,hvfhigh,hvfstd,hvflow)
--localfilesdirs <dir>[,dir,]
Directories/Folders to scan for new files
--mediaselector <identifier>
Identifier of mediaselector API to use when searching for media streams. One of: 4,5 Default: 5
--mkv
Output video in MKV container instead of MP4. There is no metadata tagging support for MKV output.
--mp3vbr
Set LAME VBR mode to N (0 to 9) for AAC transcoding. 0 = target bitrate 245 Kbit/s, 9 = target bitrate 65 Kbit/s (requires --aactomp3). Applied only to radio programmes.
--multimode
Allow the recording of more than one mode for the same programme - WARNING: will record all specified/default modes!!
--mythtv <file>
Create Mythtv streams XML of matching programmes in specified file
--non-ascii, --na
Keep non-ASCII characters in file and directory names. Default behaviour is to remove all non-ASCII characters.
--nowrite, -n
No writing of file to disk (use with -x to prevent a copy being stored on disk)
--outputliveradio <dir>
Output directory for live radio recordings (overrides --output)
--outputlivetv <dir>
Output directory for live tv recordings (overrides --output)
--outputlocalfiles <dir>
Output directory for localfiles recordings (overrides --output)
--outputpodcast <dir>
Output directory for podcast recordings (overrides --output)
--player '<command> <options>'
Use specified command to directly play the stream
--punctuation, --pu
Keep punctuation characters and symbols in file and directory names, with ellipsis always replaced by underscore. Default behaviour is to remove all punctuation and symbols except underscore, hyphen and full stop. Overridden by --fatfilename and --hfsfilename.
--refresh-abortonerror
Abort cache refresh for programme type if data for any channel fails to download. Use --refresh-exclude to temporarily skip failing channels.
--refresh-limit <days>
Minimum number of days of programmes to cache (max: 30)
--refresh-limit-radio <integer>
Number of days of radio programmes to cache. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30
--refresh-limit-tv <days>
Number of days of TV programmes to cache. Makes cache updates VERY slow. Default: 7 Min: 1 Max: 30
--rtmp-radio-opts <options>
Add custom options to rtmpdump for radio
--rtmp-tv-opts <options>
Add custom options to rtmpdump for tv
--rtmpdump <path>
Location of rtmpdump binary. Synonyms: --flvstreamer
--rtmpport <port>
Override the RTMP port (e.g. 443)
--series
Display programme series names only with number of episodes
--shoutcast-liveradio-opts <options>
Add custom options to ffmpeg Shoutcast download re-muxing for liveradio
--stdout, -x
Additionally stream to STDOUT (so you can pipe output to a player)
--stream
Stream to STDOUT (so you can pipe output to a player)
--swfurl <URL>
URL of Flash player used by rtmpdump for verification. Only use if default Flash player URL is not working.
--symlink <file>
Create symlink to <file> once we have the header of the recording
--tag-cnid
Use AtomicParsley --cnID argument (if supported) to add catalog ID used for combining HD and SD versions in iTunes
--tag-fulltitle
Prepend album/show title to track title
--tag-hdvideo
AtomicParsley accepts --hdvideo argument for HD video flag
--tag-id3sync
Save ID3 tags for MP3 files in synchronised form. Provides workaround for corruption of thumbnail images in Windows. Has no effect unless using MP3::Tag Perl module.
--tag-longdesc
AtomicParsley accepts --longdesc argument for long description text
--tag-longdescription
AtomicParsley accepts --longDescription argument for long description text
--tag-longepisode
Use <episode> (incl. episode number) instead of <episodeshort> for track title
--tag-longtitle
Prepend <series> (if available) to track title. Ignored with --tag-fulltitle.
--tag-shortname
Use <nameshort> instead of <name> for album/show title
--terse
Only show terse programme info (does not affect searching)
--thumb-ext <ext>
Thumbnail filename extension to use
--tree
Display Programme listings in a tree view
--xml-alpha
Create freevo/Mythtv menu sorted alphabetically by programme name
--xml-channels
Create freevo/Mythtv menu of channels -> programme names -> episodes
--xml-names
Create freevo/Mythtv menu of programme names -> episodes

Author

get_iplayer was written by Phil Lewis <iplayer2 (at sign) linuxcentre.net> and is now maintained by the contributors at http://www.infradead.org/get_iplayer/ht…

This manual page was originally written by Jonathan Wiltshire <jmw@debian.org> for the Debian project (but may be used by others).

Info

September 2016 Phil Lewis get_iplayer Manual