.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "WebService::YouTube::Videos 3pm" .TH WebService::YouTube::Videos 3pm "2021-01-07" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" WebService::YouTube::Videos \- Perl interface to youtube.videos.* .SH "VERSION" .IX Header "VERSION" This document describes WebService::YouTube::Videos version 1.0.3 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use WebService::YouTube::Videos; \& \& my $api = WebService::YouTube::Videos\->new( { dev_id => YOUR_DEV_ID } ); \& \& # Call API youtube.videos.list_featured \& my @videos = $api\->list_featured; \& foreach my $video (@videos) { \& # $video\->isa(\*(AqWebService::YouTube::Video\*(Aq); \& } \& \& # Call other APIs \& my @videos = $api\->list_by_user($user); \& my @videos = $api\->list_by_tag($tag); \& \& my $video = $api\->get_details($video_id); \& \& # Parse XML \& my @video = $api\->parse_xml($xml); # when $xml contains \& my $video = $api\->parse_xml($xml); # when $xml contains .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a Perl interface to YouTube \s-1REST API.\s0 .PP See \fBDeveloper APIs\fR and \fBDeveloper \s-1API\s0 \*(-- \s-1REST\s0 Interface\fR for details. .SH "SUBROUTINES/METHODS" .IX Header "SUBROUTINES/METHODS" .SS "new(\e%fields)" .IX Subsection "new(%fields)" Creates and returns a new WebService::YouTube::Videos object. \&\f(CW%fields\fR can contain parameters enumerated in \*(L"\s-1ACCESSORS\*(R"\s0 section. .SS "parse_xml($xml)" .IX Subsection "parse_xml($xml)" Parses \s-1XML\s0 and returns the result. \&\f(CW$xml\fR should be an object that XML::Simple can understand. .ie n .SS "get_details( $video_id )" .el .SS "get_details( \f(CW$video_id\fP )" .IX Subsection "get_details( $video_id )" Returns a WebService::YouTube::Video object. \&\f(CW$video_id\fR is an \s-1ID\s0 of the video which you want to get details. .PP See for details. .ie n .SS "list_by_tag( $tag, \e%fields )" .el .SS "list_by_tag( \f(CW$tag\fP, \e%fields )" .IX Subsection "list_by_tag( $tag, %fields )" Returns an array of WebService::YouTube::Video object. \&\f(CW$tag\fR is a keyword string separated by a space. \&\f(CW%fields\fR can contain the optional parameters. .IP "page" 4 .IX Item "page" 1 <= page .IP "per_page" 4 .IX Item "per_page" per_page <= 100 (default 20) .PP See for details. .ie n .SS "list_by_user( $user )" .el .SS "list_by_user( \f(CW$user\fP )" .IX Subsection "list_by_user( $user )" Returns an array of WebService::YouTube::Video object. \&\f(CW$tag\fR is a keyword string separated by a space. \&\f(CW%fields\fR can contain optional parameters. .PP See for details. .SS "list_featured( )" .IX Subsection "list_featured( )" Returns an array of WebService::YouTube::Video object. .PP See for details. .SS "\s-1ACCESSORS\s0" .IX Subsection "ACCESSORS" \fIdev_id\fR .IX Subsection "dev_id" .PP Developer \s-1ID\s0 .PP \fIua\fR .IX Subsection "ua" .PP LWP::UserAgent object .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .IP "dev_id is required" 4 .IX Item "dev_id is required" Developer \s-1ID\s0 is required when you call \s-1API\s0 of YouTube. .IP "invalid \s-1XML\s0" 4 .IX Item "invalid XML" The \s-1XML\s0 is not a YouTube's \s-1XML.\s0 .IP "unknown response" 4 .IX Item "unknown response" The ut_response is neither nor . .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" WebService::YouTube::Videos requires no configuration files or environment variables. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Class::Accessor::Fast, LWP::UserAgent, XML::Simple, WebService::YouTube::Util, WebService::YouTube::Video .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`bug\-webservice\-youtube@rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "AUTHOR" .IX Header "AUTHOR" Hironori Yoshida .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.