Subversion Repositories yt_downloader

Rev

Rev 14 | Go to most recent revision | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 14 Rev 16
Line 1... Line 1...
1 
 
 1 
 
2 
# ViaThinkSoft YouTube Downloader Util 2.3
 2 
# ViaThinkSoft YouTube Downloader 2.3.1
- 
 
 3 
 
- 
 
 4 
YouTube Downloader is a tool for Linux. It is a wrapper for youtube-dl (or any compatible forks) and offers several additional functionalities.
- 
 
 5 
 
- 
 
 6 
Special features:
- 
 
 7 
- Downloading of all videos of a channel or a playlist.
- 
 
 8 
- Automatic searching inside channels or globally (whole YouTube)
- 
 
 9 
- You can download videos and audio files.
- 
 
 10 
- YouTube-IDs can be automatically written in the ID tag of downloaded mp3 files.
- 
 
 11 
- An automatically managed list of already downloaded videos allows you to move away from the downloaded files without the risk of downloading the already downloaded files again.
- 
 
 12 
- An automatically managed list of failed downloads will avoid that a video, which is not available anymore, is tried to be downloaded too many times.
- 
 
 13 
- Creation of SFV and/or MD5 checksum files.
- 
 
 14 
- The tool is fully CLI and is optimized for cronjobs.
3 
 
 15 
 
4 
## Syntax
 16 
## Syntax
5 
 
 17 
 
6 
    ./ytdwn [-t|--type v:[ext]|a:[ext]] (default v:)
 18 
    ./ytdwn [-t|--type v:[ext]|a:[ext]] Type video or audio and preferred output type, e.g. 'a:mp3' (default v:)
7 
            [-o|--outputDir <dir>]      (default current working directory)
 19 
            [-o|--outputDir <dir>]      Default current working directory
8 
            [-a|--alreadyDownloaded <file>]
 20 
            [-a|--alreadyDownloaded <file>]
9 
            [-f|--failList <file> <treshold>]  (This file logs failures)
 21 
            [-f|--failList <file> <treshold>]  This file logs failures.
10 
            [-F|--failTreshold <num>]   (Don't download if failure (-f) treshold is reached. Default: 3)
 22 
            [-F|--failTreshold <num>]   Don't download if failure (-f) treshold is reached. (Default: 3)
11 
            [-V|--version]              (shows version)
 23 
            [-V|--version]              Shows the version
12 
            [-v|--verbose]              (displays verbose information to STDOUT)
 24 
            [-v|--verbose]              Displays verbose information to STDOUT
13 
            [-h|--help]                 (shows help)
 25 
            [-h|--help]                 Shows the help page.
14 
            [-N|--no-mp3-tagtransfer]   (disables transfer of video ID to MP3 ID tag)
 26 
            [-N|--no-mp3-tagtransfer]   Disables transfer of video ID to MP3 ID tag.
15 
                                        (This feature requires the package "id3v2")
 27 
                                        This feature requires the package "id3v2".
16 
            [-H|--checksumMode]         (Which checksum files shall be written for new files.
 28 
            [-H|--checksumMode]         Which checksum files shall be written for new files.
17 
                                        Must be 'None', 'MD5', 'SFV', or 'MD5,SFV')
 29 
                                        Must be 'None', 'MD5', 'SFV', or 'MD5,SFV'.
18 
            [-T|--default-template <t>] (Sets default filename template.)
 30 
            [-T|--default-template <t>] Sets default filename template.
19 
                                        (Default: '%(title)s-%(id)s.%(ext)s')
 31 
                                        (Default: '%(title)s-%(id)s.%(ext)s')
20 
            [-X|--extra-args <args>]    (Additional arguments passed through)
 32 
            [-X|--extra-args <args>]    Additional arguments passed through youtube-dl. (Default "-ic")
21 
                                        (youtube-dl. Default "-ic")
 - 
 
22 
            [-A|--api-key <file|key>]   (specifies the API key, or a file containing the API key)
 33 
            [-A|--api-key <file|key>]   Specifies the API key, or a file containing the API key
23 
                                        (Default: ~/.yt_api_key)
 34 
                                        (Default: ~/.yt_api_key)
24 
            [--cookies=<file>]          A netscape compatible cookie file (for age restricted videos)
 35 
            [--cookies=<file>]          A netscape compatible cookie file (for age restricted videos
25 
                                        (Default: ~/.yt_cookkies)
 36 
                                        (Default: ~/.yt_cookkies)
26 
            [-C|--resultcache <file>]   (allows video results to be cached in this file)
 37 
            [-C|--resultcache <file>]   Allows video results to be cached in this file;
27 
                                        (only for playlists or channels)
 38 
                                        only for playlists or channels.
28 
            [-O|--create-outputdir]     (allows creation of the output directories, recursively)
 39 
            [-O|--create-outputdir]     Allows creation of the output directories, recursively.
- 
 
 40 
            [--downloader=exename]      Binary file name of a youtube-dl compatible tool.
- 
 
 41 
                                        Currently supported/tested: youtube-dl, youtube-dlc, yt-dlp.
29 
            [--]
 42 
            [--]
30 
            <resource> [<resource> ...]
 43 
            <resource> [<resource> ...]
31 
 
 44 
 
32 
For all paths (outputDir, alreadyDownloaded, apikey, failList and resultcache), you can use the
 45 
For all paths (outputDir, alreadyDownloaded, apikey, failList and resultcache), you can use the
33 
term '[listname]' which will be replaced by the basename of the current list file (without file extension).
 46 
term '[listname]' which will be replaced by the basename of the current list file (without file extension).
Line 67... Line 80...
67 
Default values are `order=relevance` and `maxresults=10`
 80 
Default values are `order=relevance` and `maxresults=10`
68 
Use `maxresults=-1` to download everything which matches the searchterm.
 81 
Use `maxresults=-1` to download everything which matches the searchterm.
69 
 
 82 
 
70 
## Requirements
 83 
## Requirements
71 
- PHP CLI
 84 
- PHP CLI
72 
- Package "youtube-dl" (ytdwn will try to download it automatically, if possible)
 - 
 
73 
- A YouTube API key (can be obtained here: https://console.developers.google.com/apis/credentials )
 85 
- A YouTube API key (can be obtained here: https://console.developers.google.com/apis/credentials )
74 
- If you want to extract audio, you need additionally: ffmpeg or avconv and ffprobe or avprobe.
 86 
- If you want to extract audio, you need additionally: ffmpeg or avconv and ffprobe or avprobe.
75 
- Optional: package "id3v2" to allow the YouTube video id to be transferred to the MP3 ID tag
 87 
- Optional: package "id3v2" to allow the YouTube video id to be transferred to the MP3 ID tag
76 
 
 88 
 
77 
## Age restricted videos how-to
 89 
## Age restricted videos how-to