guide pvr - get-iplayer/get_iplayer GitHub Wiki
Guide ©Josh Archer and licensed under the Creative Commons Attribution 4.0 International license. Some edits applied.
- How do I use the get_iplayer PVR function?
- PVR controls
- How do I add a PVR record to get_iplayer?
- How do I list all PVR records in get_iplayer?
- How do I remove or delete a PVR record from get_iplayer?
- How do I run saved PVR searches in get_iplayer and automatically download programmes?
- How do I run a single saved PVR search in get_iplayer and automatically download programmes?
- How do I edit PVR records that I have already created in get_iplayer?
- How do I schedule the get_iplayer PVR function to run automatically?
This is a quick guide to the get_iplayer PVR functionality. It'll get you using the function in a couple minutes, but you'll want to make sure you've read the rest of this guide and viewed the examples at the bottom of the guide.
Doing so will make sure you build a well formed and accurate command that will download files where you want, rename them as required and can be set to run without further input from you.
Using the PVR function can be boiled down to the following commands:
Add PVR record
get_iplayer --pvr-add=PVR_Name
List all PVR record
get_iplayer --pvr-list
Remove PVR record
get_iplayer --pvr-del="name of PVR from list"
Disable PVR record
get_iplayer --pvr-disable="name of PVR from list"
Re-enable PVR record
get_iplayer --pvr-enable="name of PVR from list"
Run PVR
get_iplayer --pvr
To add a PVR record we need to 'build' it up just like we have in the previous examples.
Taking all the above commands together to build up our desired search, quality setting, channel, filename and output folder, we just add the PVR command to turn it into a PVR which you can run automatically.
This makes more sense when written:
get_iplayer --pvr-add=PVR_Name "search string goes here" --tv-quality=hd,sd,web,mobile --type=tv --channel="Channel goes here" --file-prefix="<nameshort>-<senum>-<episodeshort>" --output "/path/to/output/polder/goes/here/"
MAKE SURE YOU DON'T LEAVE SPACES IN THE PVR NAME, USE AN UNDERSCORE!
The above code is totally generic. You can change the name of the PVR to suit you, but each 'new' name you give saves a new PVR record.
I'll show you how to list and remove extraneous PVR recordings shortly. So, to change the name of our PVR to match our search string we could write something like:
get_iplayer --pvr-add=Top_Gear "Top Gear" --tv-quality=hd,sd,web,mobile --type=tv --channel="BBC Two" --file-prefix="<nameshort>-<senum>-<episodeshort>" --output "/media/TV Shows 1/2 - TV Shows/Top Gear/Season 19"
The above code will add a PVR record for Top_Gear, attempt to download the programme in HD (followed by lower-quality streams - don't worry it'll output as an MP4 automatically), make sure that the programme is a TV show, makes sure that the channel the programme is available from is BBC Two, renames the file to match the Plex/XBMC naming conventions and outputs the file to the folder "path/to/Top Gear Folder".
It's easy to list all the saved PVR records you have created. Just use the following command:
get_iplayer --pvr-list
For me this outputs:
From the list of PVR records we see above, you can easily see the names of all your PVR records, which we will need to be able to remove them using the Command Line Interface.
I'll show you how to remove them in the File Manager shortly - or skip to the bottom of the How do I edit PVR records that I have already created in get_iplayer? section to see how right now. To remove a PVR record, simply add the PVR records name to the 'Remove PVR' command like this:
get_iplayer --pvr-del="name of PVR from list"
To remove the "Top_Gear" PVR record from the list above, I'd simply use this code:
get_iplayer --pvr-del=Top_Gear
It's as easy as that. Run that command with the exact name of the PVR record in place of "name of PVR from list" and it will be removed immediately.
It wont give you any confirmation of the removal (it'll look like nothing has happened) but if you re-list your PVR records you will see that the one you specified has been removed.
This one is probably the easiest command of all. It simply this:
get_iplayer --pvr
That's it.
Once you execute that command, get_iplayer will update the list of available programmes and start performing automatic searches and downloads based on the saved PVR records you have created.
It'll output to the directories/folders you specified and rename the files as you instructed, all without any extra input from you.
Easy as pie!
Use the --pvr-single option with name of the PVR record:
get_iplayer --pvr-single="Top_Gear"
There are two ways to edit a PVR record you have already created. The first is to create another PVR record with the exact same name as the one you want to edit. This will completely overwrite the old PVR record with the new one you create. This is useful if you only have one or two PVR records to edit. If you are unsure how to create a new PVR record, jump up to the How do I add a PVR record to get_iplayer? section.
The second method is to navigate to the hidden PVR directory where the actual text files storing the PVR records are kept on your hard drive, and edit those files. Whilst this sounds trickier, it's actually easier for editing a large number of files (to change their output folder/directory if you now need get_iplayer to download them to a different folder for example). The example below is for Ubuntu Linux, but the mechanism is the same on all platforms.
The PVR directory is located inside your get_iplayer profile directory, which is a hidden directory inside your 'Home' folder. To navigate to it using the file explorer/manager, open up a new file manager window and click on 'Home' in the sidebar. Use Ctrl+H to toggle viewing of hidden files and directories.
HINT - you can also reveal hidden files using the menu located right up on the top bar at the top of the screen, but it's slower and harder to find so just use the keyboard shortcut. The file explorer window will fill up with lots of previously unseen folders, all preceded with a full-stop. You need to find and click on the ".get_iplayer" folder, outlined in the screenshot below:
Other platforms: For macOS, click on the Home icon with your username in the Finder sidebar to navigate to your home directory, then use Cmd+Shift+. to toggle viewing of hidden files and directories. For Windows navigate to "C:\Users<username>" in Windows Explorer and use Win+H to toggle viewing of hidden files and directories.
Inside the ".get_iplayer" folder, you'll find a folder called "pvr".
Open this up and you'll find a series of text files. These are the saved information from the PVR records you created through the Command Line Interface.
Simply double-click on the file you need to change and open it in a text editor. You can make changes to the record and then save the file to disk. See Setting preferences for the format of PVR records.
That's it, simple as that.
If you make a mistake and corrupt the file, just delete it and recreate the record through the Command Line Interface with the updated info you needed.
NOTE - You can use this method to delete, en masse, PVR records that you no longer require. Delete the records from this folder and the PVR searches will no longer run when you execute the "Run PVR" command.
See: PVR usage