Skip to content
notnac edited this page Jul 6, 2018 · 16 revisions

Programme information

Click here for all display options (Return to ToC)

Click here for all output options (Return to ToC)

Programme metadata

Display the programme metadata for index 123:

get_iplayer --info 123

Display the programme metadata for PID b012hbg5:

get_iplayer --info --pid=b012hbg5

Programme metadata includes the available recording modes for a programme.

Metadata files

The programme metadata can be downloaded using the --metadata option..

Save the metadata after a successful download into an XML file in the output directory:

get_iplayer --metadata --get 123

Save only the metadata for a programme into an XML file (but don't record the programme). This is useful if you forgot to download the metadata when recording.

get_iplayer --metadata-only 123

Thumbnail images

A programme thumbnail can be automatically downloaded using the --thumbnail option.

get_iplayer --thumbnail --get 123

Save only the thumbnail for a programme (but don't record the programme). This is useful if you forgot to get the thumbnail when recording.

get_iplayer --thumbnail-only 123

Use --thumbnail-size to specify the width of the image:

get_iplayer --thumbnail --thumbnail-size=1280 --get 123

See display options for supported image widths.

Use --thumbnail-square to retrieve a square version of the image:

get_iplayer --thumbnail --thumbnail-size=960 --thumbnail-square --get 123

Track lists

Use the --tracklist or --tracklist-only option to download music track lists available for some programmes.

get_iplayer --tracklist --get 123

get_iplayer --tracklist-only 123

Track lists are generally available for radio music programmes, but may exist for some TV programmes, such as Top of the Pops. The track list is downloaded to a plain text .tracks.txt file in your output directory.

  • Where available, track timings are included. Track timing data is usually only available for music programmes on national radio stations. The track timing data also may be incorrect at source.
  • When track timing data is available and --start and --stop are used, all tracks are included in the list, but only tracks between --start and --stop will have timings.

Programme credits

Use the --credits or --credits-only option to download programme credits. get_iplayer --credits --get 123

get_iplayer --credits-only 123

Credits are available for many TV programmes, and a few radio programmes. The credits are downloaded to a plain text .credits.txt file in your output directory.

Update multiple files

As long as your programmes remain in the directory they were originally recorded into you can retrospectively download the thumbnail, metadata or subtitles of the shows in your recordings history, provided that the resources are still available from the iPlayer site.

Get all thumbnails for files that still exist (in this case for programmes matching 'Doctor Who'):

get_iplayer --thumbnail-only --history --skipdeleted "Doctor Who"

Get all the metadata for files that still exist:

get_iplayer --metadata-only --metadata --history --skipdeleted ".*"

Get all subtitles for files that still exist (Note that you can only get subs if the programme is still available on iPlayer):

get_iplayer --subtitles-only --history --skipdeleted ".*"

Media stream information

Display the various media stream URLs and related info for programme index 123:

get_iplayer --streaminfo 123
Clone this wiki locally