hombecq cyrille > VideoLan-Client-0.13 > VideoLan::Client

Download:
VideoLan-Client-0.13.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.13   Source  

NAME ^

VideoLan::Client - interact with VideoLan Client using telnet connection

VERSION ^

Version 0.13

SYNOPSIS ^

use VideoLan::Client;

see METHODS section below

DESCRIPTION ^

VideoLan::Client allows you to lauchn vlc and control it using vlc connections. VideoLan::Client offer simple I/O methods. VideoLan::Client require Net::Telnet.

METHODS ^

In the calling sequences below, square brackets [] represent optional parameters.

new - create a new VideoLan::Client object
    $obj = new VideoLan::Client();
    $obj = new VideoLan::Client ([HOST => $host,]
                    [PORT => $port,]
                    [TIMEOUT => $timeout,]
                    [PASSWD => $passwd,]
                    [DEBUG => $debug_file,]
                    );

This is the constructor for VideoLan::Client objects.

host

The default host is "localhost"

port

The default port is 4212

timeout

The default timeout is 10 secondes

passwd

The default passwd is admin secondes

debug

The default debug is undef. if debug is set to $file, $file will contains the telnet connection log. debug have to be set before the login method

login - Initiate the connection with vlc
    $val = $ojb->login;

If succed return 1, else return 0.

logout - Close the connection with vlc
    $obj->logout;
shutdown - Stop the vlc and close the connection.
    $obj->shutdown;
cmd - lauchn a command to vlc and return the output
    @val = $obj->cmd('commande');
add_broadcast_media - add a broadcast media to vlc
    $obj->add_broadcast_media($name,$input,$output);

input and output use the syntaxe of vlc input/output

load_config_file - load on config file in vlc
    $obj->load_config_file($file)
save_config_file - save the running config on a file
    $obj->save_config_file($file)
media_play - Play a media
    $obj->media_play($name)
media_stop - Stop playing a media
    $obj->media_stop($name)
launchvlc - lauchn a vlc with telnet interface
    $val = lauchnvlc;

Work only if the host is localhost. Will only work on *NIX where nohup commande exist and vlc command is in path. lauchnvlc method is not support actually, just in test.

SEE ALSO ^

VLC : VideoLan Client

http://www.videolan.org/

Net::Telnet

http://search.cpan.org/~jrogers/Net-Telnet-3.03/lib/Net/Telnet.pm

EXAMPLES ^

This example connect to a running vlc, lauchn the help commande and logout.

    use VideoLan::Client;
    my $vlc = VideoLan::Client->new( HOST =>'192.168.1.10', PORT => '35342', PASSWD => 'mdp_test');
    $vlc->login();
    my @help = $vlc->cmd("help");
    $vlc->logout();

This example connect to a running vlc and shutdown it

    use VideoLan::Client;
    my $vlc = VideoLan::Client->new( PASSWD => 'mdp_test');
    $vlc->login;
    my @help = $vlc->shutdown;
    $vlc->logout;

SEE ALSO ^

VLC : VideoLan Client

http://www.videolan.org/

Net::Telnet

http://search.cpan.org/~jrogers/Net-Telnet-3.03/lib/Net/Telnet.pm

AUTHOR ^

Cyrille Hombecq, <elliryc at cpan.com>

BUGS ^

Please report any bugs or feature requests to bug-videolan-client at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=VideoLan-Client. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc VideoLan::Client

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2008 Cyrille Hombecq, all rights reserved.

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

syntax highlighting: