get_iplayer Guides and Tutorials
COMPREHENSIVE GUIDES TO GET YOU STARTED QUICKLY
get_iplayer Radio Download Guide
This guide has been written in a step by step manner for beginners. If this is your first time here you really must go through the guide in this fashion if you are to understand and get the most out of get_iplayer.
However, if you are coming back here to use this guide as a reference or just have a specific question, feel free to click on any of the links in the contents below to jump to the relevant section you need.
NOTE - Need the full get_iplayer documentation? Find it in the Wiki Documentation.
- How do I search for radio programmes using get_iplayer?
- How do I record a radio programme with get_iplayer?
- Where does get_iplayer save downloaded radio programmes?
- How do I specify or change the quality level of radio programmes downloaded in get_iplayer?
- How do I make get_iplayer automatically convert radio programmes to MP3?
- How do I change or specify where get_iplayer saves downloaded radio programmes?
- How do I permanently change where get_ipayer saves downloaded radio programmes?
How do I search for radio programmes using get_iplayer?
See the Searching section of the wiki documentation for information on get_iplayer search limitations before searching for any programmes.
If you don't know the name of the show your would like to download I would recommend using the BBC iPlayer website to browse for programmes you might enjoy. When you know the name of the show you'd like, we can begin searching.
To have get_iplayer search for the show we use the following command:
get_iplayer --type=radio "Programme Name"
It is crucial that you use the " " marks when performing a search containing more than one word. If you don't, you'll either get an error or results will only be relevant to the first word you type.
Get in the habit of using " quotation " marks for each and every search you do. In this case, the above command will search for...
That's is all there is to performing a basic search. I've not needed to use any of the more advanced options, but feel free to leave a comment in the forum if you need help with narrowing down your searches and I'll be happy to help you out.
How do I record a radio programme with get_iplayer?
Using a search string
There are two basic says to download radio programmes with get_iplayer, one uses the search string and one uses the index number. We can use this search string in combination with the "get" command to download all programmes that match this search string.
This makes more sense when we type it out:
get_iplayer --type=radio --get "Programme Name"
Once we execute this command, get_iplayer will begin to download all radio programmes that match this search string. Technically, the search term is a regular expression and acts as a sub-string, so if a programme is called:
This is a long programme name for a show
Then the above command would download this show, because "programme name" exists in the show name.
This behaviour is useful because it allows you to set up a PVR (explained in the get_iplayer PVR Guide) for a programme and it doesn't matter if the name changes slightly over time, such as "Programme Name Series 1" to "Programme Name Series 2" because the search string will still match and the download still run as "Programme Name" is still there.
Using the Index Number
The second method is to use the index number. We can use this number to tell get_iplayer to download specific programmes and nothing else. We do so using the following command:
get_iplayer --type=radio --get 1234
...where 1234 is the index number of the number you want to download. If you want to download more than one specific programme at a time, you can type the index numbers one after the other like so:
get_iplayer --type=radio --get 123 1234 12345
The PID functions very similarly to the index number. To find it you'll need to go to the page on the iplayer website and identify it in the URL (web address) that can be seen in your browsers address bar.
Lets look at an example URL:
The PID in the example above is the seemingly random string of characters
b04mctvz. In fact, many (possibly all) PIDs start with b0, so you can usually identify the PID pretty easily.
To download the programme using the PID we use the
An example of the above episode being downloaded in this fashion would be:
get_iplayer --pid=b04mctvz --type=radio
Don't forget to add
--type=radio when downloading a radio programme.
Downloading multiple PIDs
You can download multiple PIDs in a single command.
You can enter multiple PIDs in two ways:
get_iplayer --pid PID1,PID2,PID3
get_iplayer --pid PID1 --pid PID2 --pid PID3
(Remember to include
--pid when downloading radio programmes.)
You can also do the same thing with episode page URLs:
get_iplayer --url URL1,URL2,URL3
get_iplayer --url URL1 --url URL2 --url URL3
(Remember to include
--url when downloading radio programmes.)
--url where possible - it is slightly quicker and more reliable. And no, you can't download multiple PIDs or multiple URLs with the Web PVR Manager.
You can use all the other commands throughout this guide along with the
--pid command to specify the output directory and naming structure etc, just substitute it and the PID in place of
--get and the search string/index number.
That is all there is to it, nothing too hard as long as you search first and then use the simple commands above to download the programme you want.
So when using the PID method you can still use all the other commands throughout this guide along with the to specify the output directory and naming structure etc.
Where does get_iplayer save downloaded radio programmes?
get_iplayer saves files to your current working directory as a default on both Mac OS X and Linux, whereas it saves programmes to the folder you specified when first installing on Windows.
You can see how to download programmes to a directory (folder) of your choice in the How do I change or specify where get_iplayer saves downloaded radio programmes? section.
Click the link to jump there now if you need to, or if this is your first time using this guide simply read on and we'll get to that shortly.
How do I specify or change the quality level of radio programmes downloaded in get_iplayer?
For a full explanation of get_iplayer recording quality, check out the Recording Quality wiki entry.
As a default, get_iplayer will download the highest quality version of each radio programme, so you DO NOT need to change anything or use any of the commands below if you are happy with having the highest quality version. By "highest quality" I mean the version with the highest audio bit rate.
If you want to make get_iplayer download a lower quality you should use the "--radiomode" command. The code is written like this
...followed by the desired quality level. The full list of available settings to add to the above command is below:
best better vgood good worse worst
For example, you may wish to use
--radiomode=good for speech programmes and reserve the default (
--radiomode=best) for music programmes.
Quality levels are treated as maximum values. If only lower quality versions are available, get_iplayer will download the best available from those versions.
NOTE - Regardless of quality level, when you download an file, it is automatically converted to M4A (MP4 file containing AAC audio).
How do I change or specify where get_iplayer saves downloaded radio programmes?
We can set the output path of programmes get_iplayer downloads on a case by case basis. You _can_ do this globally, but it makes more sense to do this on a programme by programme basis, particularly if you are trying to ensure the relevant XBMC and Plex folder structure conventions are met.
To specify the directory/folder get_iplayer outputs downloaded files to, we use the "output" command which looks like this:
...to which we simply add the folder path:
DON'T FORGET THE QUOTATION MARKS!
The file path should go within the quotation marks. You are free to type out the location and get_iplayer will create it for you if it doesn't exist already, or it will simply add files to the directory if it already exists.
How do I permanently change where get_ipayer saves downloaded radio programmes?
It's quite common to want to permanently change the location get_iplayer saves its downloaded files. For a complete overview of all output options take a look at the Output Options in the wiki, but lets take a look at a few simple and common options you can use.
Change download location for all files
Firstly, to save a download location for all files, use the
--prefs-add command like so:
get_iplayer --prefs-add --output "/media/Radio Shows 1/2 - Radio Shows/"
This will have get_iplayer save all downloaded shows in the "2 - Radio Shows" directory in the "Radio Shows 1" disc. On Windows, the exact path will look a little different but I don't have a Windows install to show you directly.
Change download location for just Radio shows
Instead of downloading everything to one location, you might only want radio shows to go to a particular directory. It that's the case you can use the
--outputradio command like so:
get_iplayer --prefs-add --outputradio "/media/Radio Shows 1/2 - Radio Shows/"
This will have get_iplayer save ONLY radio shows in the "2 - Radio Shows" directory in the "Radio Shows 1" disc.
--outputradio option overrides the
--output command, which means if you set the
--output command, all downloads apart from radio shows will go to that location and all radio shows will go wherever
--outputradio is set.
You can set specific locations for the different types of files with the following commands. Each one will override the
--output command for their specific file type, so you have a lot of flexibility in where you can save files:
Full info in the Output Options section of the Options wiki page.
How do I make get_iplayer automatically convert radio programmes to MP3?
It is possible for get_iplayer to automatically post-process your files after download and convert them MP3. This is an advanced topic beyond the scope of this introductory guide. See the Custom Commands wiki entry for examples.