Léon Brocard > Mac-EyeTV > Mac::EyeTV::Programme

Download:
Mac-EyeTV-0.30.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Mac::EyeTV::Programme - An EyeTV programme

SYNOPSIS ^

  use Mac::EyeTV;
  my $eyetv = Mac::EyeTV->new();

  # Examine existing programmes
  foreach my $programme ($eyetv->programmes) {
    my $start       = $programme->start;
    my $stop        = $programme->stop;
    my $title       = $programme->title;
    my $description = $programme->description;

    print "$title $start - $stop ($description)\n";
  }

  # Record a new programme
  my $programme = Mac::EyeTV::Programme->new;
  $programme->start($start_dt);
  $programme->stop($stop_dt);
  $programme->title($title);
  $programme->description($description);
  $programme->channel_number($channel_number);
  $programme->record;

  # Export an existing recording
  $programme->export("new.mpg");

  # Delete an existing programme
  $programme->delete;

DESCRIPTION ^

This module represents an EyeTV program. The programmes() method in Mac::EyeTV returns a list of Mac::EyeTV::Programme objects which represent the existing and future programs.

METHODS ^

new

This is the constructor, which takes no arguments:

  my $eyetv = Mac::EyeTV->new();

export

Exports the programme as an MPEGPS file:

  $programme->export("new.mpg");

delete

The delete() method deletes the programme:

  $programme->delete;

description

The description() method returns the description of the programme:

  my $description = $programme->description;

duration

The duration() method returns the duration of the programme (as a DateTime::Duration object):

  my $duration = $programme->duration;

record

The record method schedules a new recording:

  # Record a new program
  my $programme = Mac::EyeTV::Programme->new;
  $programme->start($start_dt);
  $programme->stop($stop_dt);
  $programme->title($title);
  $programme->description($description);
  $programme->channel_number($channel_number);
  $programme->record;

start

The start method returns when the programme starts (as a DateTime object):

  my $start = $programme->start;

stop

The stop method returns when the programme stops (as a DateTime object):

  my $stop = $programme->stop;

title

The title() method returns the title of the programme:

  my $title = $programme->title;

AUTHOR ^

Leon Brocard <acme@astray.com>.

COPYRIGHT ^

Copyright (C) 2004-5, Leon Brocard

This module is free software; you can redistribute it or modify it under the same terms as Perl itself.

syntax highlighting: