File Coverage

blib/lib/Audio/Beep/Linux/beep.pm

Criterion	Covered	Total	%
statement	11	19	57.8
branch	2	4	50.0
condition	2	6	33.3
subroutine	3	5	60.0
pod	0	3	0.0
total	18	37	48.6

package Audio::Beep::Linux::beep;

$Audio::Beep::Linux::beep::VERSION = 0.11;

use strict;

sub new {
    my $class = shift;
    my %hash = @_;
    $hash{path} ||= _search_path();
    return unless $hash{path};
    return bless \%hash, $class;
}

sub play {
    my $self = shift;
    my ($pitch, $duration) = @_;
    return `\Q$self->{path}\E -l $duration -f $pitch`;
}

sub rest {
    my $self = shift;
    my ($duration) = @_;
    select undef, undef, undef, $duration/1000;
    return 1;
}

sub _search_path {
    my @prob_paths = qw(
        /usr/bin/beep
        /usr/local/bin/beep
        /bin/beep
    );
    do { return $_ if -e and -x _ } for @prob_paths;
    return;
}

=head1 NAME

Audio::Beep::Linux::beep - Audio::Beep player module using the B program

=head1 SYNOPIS

    my $player = Audio::Beep::Linux::beep->new([%options]);

=head1 USAGE

The C class method can receive as option in hash fashion the following
directives

=over 4

=item path => '/full/path/to/beep'

With the path option you can set the full path to the B program in
the object. If you don't use this option the new method will look anyway
in some likely places where B should be before returning undef.

=back

=head1 NOTES

The B program is a Linux program wrote by Johnathan Nightingale.
You should find C sources in the tarball where you found this file.
The B program needs to be (usually) executed as root to actually work.
Please check C for more info.

=head1 BUGS

None known.

=head1 COPYRIGHT

Copyright 2003-2004 Giulio Motta L.

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

=cut

1;