README
1NAME
2 Net::TiVo - Perl interface to TiVo.
3
4INSTALLATION
5 % perl Makefile.PL
6 % make
7 % make test
8 % make install
9
10REQUIREMENTS
11 XML::Simple
12 Log::Log4perl
13 LWP::UserAgent
14
15PLATFORMS
16 I have tested it on the following platforms, but it should work on any platform
17 that runs Perl, and meets the above requirements.
18
19 FreeBSD v6.1
20
21SYNOPSIS
22 use Net::TiVo;
23
24 my $tivo = Net::TiVo->new(
25 host => '192.168.1.25',
26 mac => 'MEDIA_ACCESS_KEY'
27 );
28
29 for ($tivo->folders()) {
30 print $_->as_string(), "\n";
31 }
32
33ABSTRACT
34 "Net::TiVo" provides an object-oriented interface to TiVo's REST
35 interface. This makes it possible to enumerate the folders and shows,
36 and dump their meta-data.
37
38DESCRIPTION
39 "Net::TiVo" has a very simple interface, and currently only supports the
40 enumeration of folder and shows using the REST interface. The main
41 purpose of this module was to provide access to the TiVo
42 programmatically to automate the process of downloading shows from a
43 TiVo.
44
45 "Net::TiVo" does not provide support for downloading from TiVo. There
46 are several options available, including LWP, wget, and curl. Note: I
47 have used wget version >= 1.10 with success. wget version 1.09 appeared
48 to have an issue with TiVo's cookie.
49
50CACHING
51 "Net::TiVo" is slow due to the amount of time it takes to fetch data
52 from TiVo. This is greatly sped up by using a cache. "Net::TiVo"'s "new"
53 method accepts a reference to a "Cache" object. Any type of caching
54 object may be supported as long as it meets the requirements below.
55 There are several cache implementations available on CPAN, such as
56 "Cache::Cache".
57
58 The following example creates a cache that lasts for 600 seconds.
59
60 use Cache::FileCache;
61
62 my $cache = Cache::FileCache->new(
63 namespace => 'TiVo',
64 default_expires_in => 600,
65 }
66
67 my $tivo = Net::TiVo->new(
68 host => '192.168.1.25',
69 mac => 'MEDIA_ACCESS_KEY',
70 cache => $cache,
71 }
72
73 "Net::TiVo" uses *positive* caching, errors are not stored in the cache.
74
75 Any "Cache" class may be used as long as it supports the following
76 method signatures.
77
78 # Set a cache value
79 $cache->set($key, $value);
80
81 # Get a cache value
82 $cache->get($key);
83
84 METHODS
85 folders()
86 Returns an array in list context or array reference in scalar
87 context containing a list of Net::TiVo::Folder objects.
88
89LICENSE
90 This library is free software; you can redistribute it and/or modify
91 it under the same terms as Perl itself.
92
93SEE ALSO
94 Net::TiVo::Folder, Net::TiVo::Show
95
96AUTHOR
97 Christopher Boumenot, <boumenot@gmail.com>
98
99