1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# NAME
WWW::YouTube::Download - WWW::YouTube::Download - Very simple YouTube video download interface
# VERSION
version 0.65
# SYNOPSIS
use WWW::YouTube::Download;
my $client = WWW::YouTube::Download->new;
$client->download($video_id);
my $video_url = $client->get_video_url($video_id);
my $title = $client->get_title($video_id); # maybe encoded utf8 string.
my $fmt = $client->get_fmt($video_id); # maybe highest quality.
my $suffix = $client->get_suffix($video_id); # maybe highest quality file suffix
# DESCRIPTION
WWW::YouTube::Download is a library to download videos from YouTube. It relies entirely on
scraping a video's webpage and does not use YT's /get\_video\_info URL space.
# METHODS
- **new()**
$client = WWW::YouTube::Download->new;
Creates a WWW::YouTube::Download instance.
- **download($video\_id \[, \\%args\])**
$client->download($video_id);
$client->download($video_id, {
fmt => 37,
filename => 'sample.mp4', # save file name
});
$client->download($video_id, {
filename => '{title}.{suffix}', # maybe `video_title.mp4`
});
$client->download($video_id, {
cb => \&callback,
});
Download the video file.
The first parameter is passed to YouTube video url.
Allowed arguments:
- `cb`
Set a callback subroutine, SEE [LWP::UserAgent](https://metacpan.org/pod/LWP%3A%3AUserAgent) ':content\_cb'
for details.
- `filename`
Set the filename, possibly using placeholders to be filled with
information gathered about the video.
`filename` supported format placeholders:
{video_id}
{title}
{user}
{fmt}
{suffix}
{resolution}
Output filename is set to `{video_id}.{suffix}` by default.
- `file_name`
**DEPRECATED** alternative for `filename`.
- `fmt`
set the format to download. Defaults to the best video quality
(inferred by the available resolutions).
- **playback\_url($video\_id, \[, \\%args\])**
$client->playback_url($video_id);
$client->playback_url($video_id, { fmt => 37 });
Return playback URL of the video. This is direct link to the movie file.
Function supports only "fmt" option.
- **prepare\_download($video\_id)**
Gather data about the video. A hash reference is returned, with the following
keys:
- `fmt`
the default, suggested format. It is inferred by selecting the
alternative with the highest resolution.
- `fmt_list`
the list of available formats, as an array reference.
- `suffix`
the filename extension associated to the default format (see `fmt`
above).
- `title`
the title of the video
- `user`
the YouTube user owning the video
- `video_id`
the video identifier
- `video_url`
the URL of the video associated to the default format (see `fmt`
above).
- `video_url_map`
an hash reference containing details about all available formats.
The `video_url_map` has one key/value pair for each available format,
where the key is the format identifier (can be used as `fmt` parameter
for ["download"](#download), for example) and the value is a hash reference with
the following data:
- `fmt`
the format specifier, that can be passed to ["download"](#download)
- `resolution`
the resolution as _width_x_height_
- `suffix`
the suffix, providing a hint about the video format (e.g. webm, flv, ...)
- `url`
the URL where the video can be found
- **ua(\[$ua\])**
$self->ua->agent();
$self->ua($LWP_LIKE_OBJECT);
Sets and gets LWP::UserAgent object.
- **video\_id($url)**
Parses given URL and returns video ID.
- **playlist\_id($url)**
Parses given URL and returns playlist ID.
- **user\_id($url)**
Parses given URL and returns YouTube username.
- **get\_video\_id($video\_id)**
- **get\_video\_url($video\_id)**
- **get\_title($video\_id)**
- **get\_user($video\_id)**
- **get\_fmt($video\_id)**
- **get\_fmt\_list($video\_id)**
- **get\_suffix($video\_id)**
- **playlist($id,$ref)**
Fetches a playlist and returns a ref to an array of hashes, where each hash
represents a video from the playlist with youtube id, runtime in seconds
and title. On playlists with many videos, the method iteratively downloads
pages until the playlist is complete.
Optionally accepts a second argument, a hashref of options. Currently, you
can pass a "limit" value to stop downloading of subsequent pages on larger
playlists after x-amount of fetches (a limit of fetches, not playlist items).
For example, pass 1 to only download the first page of videos from a playlist
in order to "skim" the "tip" of new videos in a playlist. YouTube currently
returns 100 videos at max per page.
This method is used by the _youtube-playlists.pl_ script.
# CONTRIBUTORS
yusukebe
# BUG REPORTING
Please use github issues: [https://github.com/xaicron/p5-www-youtube-download/issues](https://github.com/xaicron/p5-www-youtube-download/issues).
# SEE ALSO
[WWW::YouTube::Info](https://metacpan.org/pod/WWW%3A%3AYouTube%3A%3AInfo) and [WWW::YouTube::Info::Simple](https://metacpan.org/pod/WWW%3A%3AYouTube%3A%3AInfo%3A%3ASimple).
[WWW::NicoVideo::Download](https://metacpan.org/pod/WWW%3A%3ANicoVideo%3A%3ADownload)
[http://rg3.github.io/youtube-dl/](http://rg3.github.io/youtube-dl/)
# AUTHOR
xaicron <xaicron {@} cpan.org>
# COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Yuji Shimada.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
