MAN page from Mandrake 7.X AfterStep-1.7.142-5mdk.i586.rpm

Audio

Section: Misc. Reference Manual Pages (1.7)
Updated: Dec 10 1998
Index

NAME

Audio - the AfterStep Sounds module

SYNOPSIS

Audio [-f config_file] [-v | --version] [-h | --help]

Although Audio can be run from the command line, it is normally spawned by afterstep in the autoexec file, in the following manner:

        Module  "I"     Audio or from within an afterstep menu file by 'Audio':% cat "~/GNUstep/Library/AfterStep/start/Modules/Audio"        Module "Audio" Audio        MiniPixmap "mini-as.xpm"

DESCRIPTION

The Audio module communicates with the AfterStep window manager tobind audio sounds to window manager actions. Different audio queues may beassigned to any window manager action. Audio can be used withany independent audio player, and therefore requires no special audiolibrary APIs of its own. Simple in its design, it merely binds the audiofilenames to particular actions and forks off the audio player programwith the appropriate filename when that action occurs.

Audio can also have builtin support for the rplay library.

OPTIONS

-f config_file: Use config_file instead of the default configuration file.
-h | --help: Print a usage message and exit successfully.
-v | --version: Print version information and exit successfully.

INITIALIZATION

During initialization, Audio will search for a configuration filewhich describes the audio player and sound files associated with actions,to use. This file will be the one specified by the -f option (if given). Else, the ~/GNUstep/Library/AfterStep/audio file will be used if it exists. Else, /usr/local/share/afterstep/audio will be used.

INVOCATION

Audio can be invoked from the autoexec file or from a menuitem as shown in the Synopsis section above.

AfterStep will search through the directories specified in theModulePath configuration in the base.#bpp (where # is yourcolordepth) to attempt to locate Audio.

CONFIGURATION OPTIONS

Audio reads the audio file when it starts up and looks forits configuration options.

*AudioPath path: Specifies the path to look for the audio files. This optionis ignored when rplay is used.
*AudioPlayCmd player: This determines the independent audio player program that will actuallyplay the sounds. If the player is set to builtin-rplaythen the builtin rplay support will be used.
*AudioDelay seconds: Specifies that sound events will only be played if they occurat least so many seconds after the previous event. Sound events thatoccur during the delay period are ignored. This option is useful if you don't want several sounds playing at the same time. The defaultdelay is 0 which disables the audio delay.
*AudioRplayHost hostname: Specifies what host the sounds will play on. The hostname can alsobe an environment variable such as $HOSTDISPLAY. This option is only validwith builtin rplay support.
*AudioRplayPriority priority: Specifies what priority will be assigned to the sounds when theyare played. This option is only valid with builtin rplay support.
*AudioRplayVolume level: Specifies what volume level will be assigned to the sounds when theyare played. This option is only valid with builtin rplay support.
*Audio action filename: Binds the particular window manager action that the soundfilename is played for.

The following actions are available for sounds:

startup shutdownunknownadd_windowraise_windowlower_windowfocus_changedestroy_windowiconifydeiconifytoggle_pagingnew_pagenew_deskconfigure_windowwindow_nameicon_nameres_classres_nameend_windowlist

AUTHORS

Frank Fejes <frankAATTssax.com>

Dan Weeks <danAATTmango.sfasu.edu>Szijarto Szabolcs <sabyAATTsch.bme.hu>Mark Boyns <boynsAATTsdsu.edu>Mark Scott <mscottAATTmcd.mot.com>Robert NationDavid Mihm <davemannAATTionet.net> [man page]

This document was created byman2html,using the manual pages.