MAN Solaris - esdctl (1)

advertisement


NAME

esdctl - Enlightened Sound Daemon (esd) control program

CONTENTS

SYNOPSIS

esdctl [-h] [--help] [-p string] [-s hostname:port] command

advertisements

advertisements


DESCRIPTION

The esdctl utility is a command-line control program for the Enlightened Sound Daemon (esd).

OPTIONS

The following options are supported:

-p string Prefix for cached samples. You can also specify this option as follows:

--prefix=string

-s hostname:port Contact the esd server on hostname at port. You can also specify this option as follows:

--server=hostname:port

-h, --help Display help text, and exit.

OPERANDS

The following operands are supported:

command The following commands are supported:

allinfo Get player and sample information from the server

cache sample Cache a sample in the server

free name Uncache a sample in the server

getid name Retrieve a sample id, given the sample name

lock Do not allow foreign clients to use the server

loop name Make a cached sample loop

off Suspend sound output so that other programs can use the audio device (this is the same as the standby option)

on Resume sound output so that only esd can use the audio device (this is the same as the resume option)

pansample id left right Set default panning for a sample, where id is the sample ID, and left and right are integers in the range 0 to 255

panstream id left right Set panning for a stream, where id is the stream ID, and left and right are integers in the range 0 to 255

play name Play a cached sample once

resume Resume sound output so that only esd can use the audio device (this is the same as the on option)

serverinfo Get server information from the server

standby Suspend sound output so that other programs can use the audio device (this is the same as the off option)

standbymode Check whether the server is on standby

stop name Stop the looping sample at the end

unlock Allow foreign clients to use the server

EXAMPLES

Example 1: Putting esd into Standby Mode

example% esdctl standby

Example 2: Ending Standby Mode

example% esdctl resume

Example 3: Loading a sample into the esd cache

example% esdctl cache info.wav
Sample <3> uploaded. Name = esdctl:info.wav

This output indicates that the sample id is 3, and the sample name is esdctl:info.wav.

Example 4: Getting a sample id from the esd cache

example% esdctl getid esdctl:info.wav

Example 5: Playing a sample from the esd cache

example% esdctl play esdctl:info.wav

Example 6: Playing and looping a sample

example% esdctl loop esdctl:info.wav

Example 7: Stopping a looped sample that is being played

example% esdctl stop esdctl:info.wav

Example 8: Removing a sample from the esd cache

example% esdctl free esdctl:info.wav

Example 9: Setting panning for a stream

example% esdctl panstream 1 100 155

Example 10: Setting panning for a sample

example% esdctl pansample 1 155 100

EXIT STATUS

The following exit values are returned:

0 Application exited successfully

>0 Application exited with failure

FILES

The following files are used by this application:

/usr/bin/esdctl Executable for Enlightened Sound Daemon control program

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
AvailabilitySUNWgnome-audio
Interface stabilityVolatile

SEE ALSO

esdcat(1), esdplay(1), esdrec(1), esdsample(1), esdmon(1), esd-config(1), libesd(3)

NOTES

Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006.

Jump to page    or go to Top of page |  Section 1 |  Main Solaris Index.


SunOS 5.11 esdctl (1) 8 Jan 2003
Generated by Open Solaris Forum from /usr/share/man/man1/esdctl.1 using man macros with tbl support.