lib/WWW/Quvi.pod

   1 =head1 NAME
   2
   3 WWW::Quvi - Perl extension interface for libquvi
   4
   5 =head1 SYNOPSIS
   6
   7     use WWW::Quvi;
   8     my $opts  = new WWW::Quvi::Options;
   9     my $query = new WWW::Quvi::Query;
  10     my $video = $query->parse ($url, $opts);
  11     if ($video->{ok}) {
  12         # ...
  13     }
  14     else {
  15         die "libquvi: error: $query->{last_error}";
  16     }
  17
  18 =head1 DESCRIPTION
  19
  20 WWW::Quvi is a Perl extension interface for libquvi.
  21
  22 =head1 DOCUMENTATION
  23
  24 This module provides a Perl interface to libquvi. This documentation
  25 contains the Perl specific details and some sample code. The libquvi
  26 documentation should be consulted for the API details at
  27 L<http://quvi.googlecode.com/>.
  28
  29 =head1 WWW::Quvi::version
  30
  31 A wrapper function that returns WWW::Quvi version and libquvi version
  32 information.
  33
  34     use warnings;
  35     use strict;
  36
  37     print WWW::Quvi::version; # Module version
  38     print WWW::Quvi::version (WWW::Quvi::ModuleVersion); # Same as above.
  39     print WWW::Quvi::version (WWW::Quvi::libquviVersion);
  40     print WWW::Quvi::version (WWW::Quvi::libquviVersionLong);
  41
  42 =head1 WWW::Quvi::Options
  43
  44 A container hash for the options used with libquvi that would normally
  45 (using the C API) be set with C<quvi_setopt(3)>.
  46
  47     use warnings;
  48     use strict;
  49
  50     use WWW::Quvi;
  51
  52     my $opts = new WWW::Quvi::Options;
  53
  54     $opts->{user_agent}      = 'Foo/1.0';         # Default: ""
  55     $opts->{http_proxy}      = 'http://foo:1234'; # Default: ""
  56     $opts->{format}          = 'hd';              # Default: "default"
  57     $opts->{verify}          = 0;                 # Default: 1
  58     $opts->{verbose_libcurl} = 1;                 # Default: 0
  59
  60 =head1 WWW::Quvi::Video
  61
  62 A container hash that holds the parsed video details.
  63
  64     print "
  65         $video->{title}
  66         $video->{host}
  67         $video->{url}
  68         $video->{id}
  69         $video->{ok}
  70     ";
  71
  72 =head1 WWW::Quvi::Link
  73
  74 A container hash that holds the parsed video link details. A member of
  75 the L</WWW::Quvi::Video> hash.
  76
  77     print "
  78         $video->{link}->{content_type}
  79         $video->{link}->{file_suffix}
  80         $video->{link}->{length_bytes}
  81         $video->{link}->{url}
  82     ";
  83
  84 =head1 WWW::Quvi::Query
  85
  86 Glues the above together.
  87
  88     # An Options instance is required.
  89     # See WWW::Quvi::Options above for the available keys.
  90
  91     my $opts  = new WWW::Quvi::Options;
  92
  93     # Initializes libquvi (quvi_init), croaks if that fails.
  94
  95     my $query = new WWW::Quvi::Query;
  96
  97     # Perform a query.
  98
  99     my $url   = "http://www.youtube.com/watch?v=DUM1284TqFc";
 100     my $video = $query->parse ($url, $opts);
 101
 102     if ($video->{ok}) {
 103         # Do whatever with the parsed video details.
 104     }
 105     else {
 106         die "libquvi: error: $query->{last_error}";
 107         # Other things to check:
 108         #   * $query->{quvi_code}
 109         #   * $query->{resp_code}
 110     }
 111
 112     # Iterate supported websites:
 113
 114     while (1) {
 115         my ($done, $domain, $formats) = $query->next_website;
 116
 117         last if $done;
 118
 119         print "$domain\t$formats\n";
 120     }
 121
 122 =head1 NOT IMPLEMENTED
 123
 124 =over 4
 125
 126 =item B<Callbacks>
 127
 128 e.g. quvi_callback_status, quvi_callback_write.
 129
 130 =item B<Video segments>
 131
 132 libquvi supports these for historical reasons only. Basically each
 133 video would have one or more video segments which had to be
 134 downloaded as separately.
 135
 136 =back
 137
 138 =head1 AUTHOR
 139
 140 Toni Gundogdu <legatvs at sign gmail com>.
 141
 142 =head1 COPYRIGHT
 143
 144 Copyright (C) 2010 Toni Gundogdu.
 145
 146 This program is free software: you can redistribute it and/or modify
 147 it under the terms of the GNU General Public License as published by
 148 the Free Software Foundation, either version 3 of the License, or
 149 (at your option) any later version.
 150
 151 This program is distributed in the hope that it will be useful,
 152 but WITHOUT ANY WARRANTY; without even the implied warranty of
 153 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 154 GNU General Public License for more details.
 155
 156 You should have received a copy of the GNU General Public License
 157 along with this program.  If not, see L<http://www.gnu.org/licenses/>.
 158
 159 =head1 SEE ALSO
 160
 161 E<lt>http://www-quvi.googlecode.com/E<gt>
 162
 163 E<lt>http://quvi.googlecode.com/E<gt>
 164
 165 E<lt>git://repo.or.cz/www-quvi.gitE<gt>
 166
 167 =cut