man1/Quvi.pod

   1 =head1 NAME
   2
   3 WWW::Quvi - Perl extension interface for libquvi
   4
   5 =head1 SYNOPSIS
   6
   7   use WWW::Quvi;
   8
   9   my $q = new WWW::Quvi::Query;
  10   my $m = $query->parse($url);
  11
  12   croak "error: $q->{errmsg}\n" unless $m->{ok};
  13
  14 =head1 DESCRIPTION
  15
  16 WWW::Quvi provides a Perl interface to libquvi, a small C library for
  17 parsing Flash media stream URLs.
  18
  19 =head1 DOCUMENTATION
  20
  21 This module provides a Perl interface to libquvi. This documentation
  22 contains the Perl specific details and some sample code. The libquvi
  23 documentation should be consulted for the API details at
  24 L<http://quvi.sourceforge.net/>.
  25
  26 =head1 WWW::Quvi::version
  27
  28 A wrapper function that returns WWW::Quvi version and libquvi version
  29 information.
  30
  31   WWW::Quvi::version;                           # Module version
  32   WWW::Quvi::version(WWW::Quvi::ModuleVersion); # Ditto.
  33   WWW::Quvi::version(WWW::Quvi::libquviVersion);
  34   WWW::Quvi::version(WWW::Quvi::libquviVersionLong);
  35
  36 =head1 WWW::Quvi::Options
  37
  38 A container hash for the options used with libquvi that would normally
  39 (using the C API) be set with C<quvi_setopt(3)>.
  40
  41   $opts->{verbose_libcurl} = 1;                    # Default: 0
  42   $opts->{user_agent}      = 'Foo/1.0';            # Default: ""
  43   $opts->{http_proxy}      = 'http://foo:1234';    # Default: ""
  44   $opts->{category}        = WWW::Quvi::ProtoHttp; # Default: ProtoAll
  45   $opts->{resolve}         = 0;                    # Default: 1
  46   $opts->{format}          = 'best';               # Default: "default"
  47   $opts->{verify}          = 0;                    # Default: 1
  48
  49 =head1 WWW::Quvi::Media
  50
  51 A container hash that holds the parsed media details accessible using
  52 C<quvi_getprop(3)>.
  53
  54   $media->{content_length}  - Content length as returned by the server
  55   $media->{thumbnail_url}   - Thumbnail URL (if any)
  56   $media->{content_type}    - Content-type as returned by the server
  57   $media->{file_suffix}     - File suffix parsed from the content-type
  58   $media->{start_time}      - Start time for media (if any)
  59   $media->{page_title}      - Media title
  60   $media->{page_url}        - Page URL
  61   $media->{duration}        - Duration in msec (if any)
  62   $media->{host}            - Host string
  63   $media->{url}             - Media stream URL
  64   $media->{id}              - Media ID
  65   $media->{ok}              - Non-zero value if parsing succeeded
  66
  67 =head1 WWW::Quvi::Query
  68
  69 =over 4
  70
  71 =item parse($url)
  72
  73 Parse media details for URL. Returns WWW::Quvi::Media object.
  74
  75   my $m = $q->parse($url);
  76
  77 =item ($rc, $domain, $formats) next_website()
  78
  79 Return next supported website. The returned tuple will hold return code
  80 ($rc), domain string and the formats string.
  81
  82 Please note that the formats string has very little use as of
  83 libquvi 0.2.17. This function is best suited for getting a list of the
  84 supported websites.
  85
  86 Use the C<formats> function (below) instead if you need to know which
  87 formats are available to an URL.
  88
  89   while (1) {
  90     my ($done, $domain) = $q->next_website;
  91     last if $done;
  92     print "$domain\n";
  93   }
  94
  95 =item ($rc, $formats) formats($url)
  96
  97 Return a list of formats available to an URL.
  98
  99   my ($rc, $formats) = q->formats($url);
 100   croak "error: $q->{errmsg}\n" unless $rc == WWW::Quvi::OK;
 101   print "$_\n" foreach (split /\|/, $formats);
 102
 103 =item set_opts($opts)
 104
 105 Set Query options (see also L</WWW::Quvi::Options>).
 106
 107 =item supported($url)
 108
 109 Returns a non-zero value if the URL is not supported.
 110
 111 =back
 112
 113 =head1 NOT IMPLEMENTED
 114
 115 =over 4
 116
 117 =item B<Linked list interface>
 118
 119 =item B<Network interface>
 120
 121 =item B<Media segments>
 122
 123 =item B<Callbacks>
 124
 125 =back
 126
 127 =head1 WWW
 128
 129  Home  : http://www-quvi.sourceforge.net/
 130  gitweb: http://repo.or.cz/w/www-quvi.git
 131
 132 =head1 LICENSE
 133
 134 WWW::Quvi is free software, licensed under the LGPLv2.1+.
 135
 136 =head1 SEE ALSO
 137
 138 C<quvi(1)>
 139
 140 =head1 AUTHOR
 141
 142 Toni Gundogdu <legatvs at sign gmail com>