Erick Calder > POE-Component-Player-Slideshow > POE::Component::Player::Slideshow

Download:
POE-Component-Player-Slideshow-1.4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.4   Source  

NAME ^

POE::Component::Player::Slideshow - a wrapper for the qiv application

SYNOPSIS ^

 use POE qw(Component::Player::Slideshow);

 $mp = POE::Component::Player::Slideshow->new();
 $mp->play("/tmp/pix");

 POE::Kernel->run();

DESCRIPTION ^

This component is used to manipulate a slideshow viewer from within a POE application. At present it works with the qiv, the QuickView viewer.

METHODS ^

An object oriented interface is provided as follows:

new [hash[-ref]]

Used to initialise the system and create a module instance. The optional hash (or hash reference) may contain any of the following keys:

alias

Indicates the name of a session to which events will be posted. Default: main.

disp

Specifies X display to use. Default: localhost:0.

delay

Indicates the delay (in 1/100ths of a second) to display each image. Default: 150.

ext

Specifies which file extensions to use. Default: *.

xargs

Allows for passing extra arguments to the underlying application.

play <dir> [options]

This method requires a parameter specifying the directory which contains the images. Warnings are issued if either the path passed is not a directory, or if the directory cannot be read.

Additionally the following arguments may be passed:

random

Specifies that the directory listing should be shuffled before playing.

window

Used to suppress display of the slideshow in full screen mode.

noscale

Used to suppress automatically scaling of images to fit the screen.

delay disp

This arguments may be passed to override the defaults supplied to new().

quit pause resume

None of these methods take any parameters and will do exactly as thier name implies. Please note that pause/resume are semaphored i.e. issuing a pause whilst the system is already paused will do exactly diddley :)

playing paused stopped

Provides a means of testing the player' state.

xcmd <string>

This method allows for the sending of arbitrary commands to the player and is useful for easily extending the functionality of the wrapper. For information on available commands please see the underlying viewer's documentation.

fullscreen fitscreen random status delete help =head2 dimmer/brigher contup/contdown zoomin/zoomout =head2 fliphorz/flipvert rotleft/rotright next/prev

The above enumerated methods perform the functions described. Those presented in pairs (divided by slashes) act in opposition to each other whilst those presented singly act as toggles.

For greater detail on the meaning of these methods please refer to the underlying viewers documentation.

EVENTS ^

At present no events are thrown by this component.

AUTHOR ^

Erick Calder <ecalder@cpan.org>

AVAILABILITY + SUPPORT ^

For support e-mail the author. This module may be found on the CPAN. Additionally, both the module and its RPM package are available from:

http://perl.arix.com

ACKNOWLEDGEMENTS ^

The test suite in this package includes a number of images that were graciously donated by Marion Lane, a most intriguing artist doing some unbelievable things with acryllic. Check out her web site at: http://www.marionlane.com - or look out for her on eBay.

Thanks Marion! ...and keep up the good work!

DATE ^

$Date: 2002/12/10 02:07:45 $

VERSION ^

$Revision: 1.4 $

LICENSE AND COPYRIGHT ^

Copyright (c) 2002 Erick Calder. This product is distributed under the MIT License. A copy of this license was included in a file called LICENSE. If for some reason, this file was not included, please see http://www.opensource.org/licenses/mit-license.html to obtain a copy of this license.

syntax highlighting: