File Coverage

blib/lib/Net/OpenSoundControl/Client.pm

Criterion	Covered	Total	%
statement	15	32	46.8
branch	0	2	0.0
condition	0	7	0.0
subroutine	5	10	50.0
pod	5	5	100.0
total	25	56	44.6

package Net::OpenSoundControl::Client;

use 5.006;
use strict;
use warnings;
use IO::Socket;
use Net::OpenSoundControl;

our @ISA = qw();

our $VERSION = '0.02';

=head1 NAME

Net::OpenSoundControl::Client - OpenSound Control client implementation

=head1 SYNOPSIS

  use Net::OpenSoundControl::Client;

  my $client = Net::OpenSoundControl::Client->new(
      Host => "192.168.3.240", Port => 7777)
      or die "Could not start client: $@\n";

  # This is a very slow fade-in...
  for (0..100) {
      $client->send(['/Main/Volume', 'f', $_ / 100]);
      sleep(1);
  }

=head1 DESCRIPTION

This module implements an OSC client sending messages via UDP.

=head1 METHODS

=over

=item new(Host => Host, Port => $port, Name => $name)

Creates a new client object. The default host is localhost, the default port 7123 and the default name C.

Returns undef on failure (in this case, $@ is set).

=cut

sub new {
    my $class = shift;
    my %opts  = @_;
    my $self  = {};

    $self->{HOST} = $opts{Host} || "localhost";
    $self->{PORT} = $opts{Port} || 7123;
    $self->{NAME} = $opts{Name}
      || 'Net-OpenSoundControl-Client talking to ' . $self->{HOST} . ':' .
      $self->{PORT};

    $self->{SOCKET} = IO::Socket::INET->new(
        PeerAddr => $self->{HOST},
        PeerPort => $self->{PORT},
        Proto    => 'udp')
      or return undef;    # error is in $@

    bless $self, $class;
}

=item name()

Returns the name of the client

=cut

sub name {
    my $self = shift;

    return $self->{NAME};
}

=item host()

Returns the server host we are talking to

=cut

sub host {
    my $self = shift;

    return $self->{HOST};
}

=item port()

Returns the server port we are talking to

=cut

sub port {
    my $self = shift;

    return $self->{PORT};
}

=item send($data)

Sends an OSC message or bundle to the server

=cut

sub send {
    my $self = shift;
    my ($data) = @_;

    $self->{SOCKET}->send(Net::OpenSoundControl::encode($data));
}

1;

=back

=head1 SEE ALSO

The OpenSound Control website: http://www.cnmat.berkeley.edu/OpenSoundControl/

L

=head1 AUTHOR

Christian Renz, Ecrenz @ web42.comE

=head1 COPYRIGHT AND LICENSE

Copyright 2004-2005 by Christian Renz Ecrenz @ web42.comE

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

=cut