xmms

NAME

SYNOPSIS

DESCRIPTION

This command provides access to the xmms media player to control playback, playlist, skins and equalizer functions. The optional ?-session n? can be used to specify a specific xmms player session, this defaults to session 0 and only makes sense when 'allow multiple instances' of the xmms player options has been set.

The legal command's are:

xmms isrunning ?-session n?

Returns 1 if xmms is running, 0 otherwise.

xmms run ?-timeout n path arg arg ...?

Starts a new xmms session and returns the session id, raises an error if a new session could not be created (timeout, out of memory, etc.). You can specify path and args to xmms, by default the path is seached for xmms. If you only want to specify args, but the path should be used to find xmms, the ?path? should be specified as 'xmms'. ?-timeout n? defaults to 5000 milliseconds, and can be used to specify how long to wait for the new session. If you specify a ?-timeout? value of 0, xmms will not yet be running when 'xmms run' returns, but no error will be raised either. The ?-session n? argument must not be specified for this subcommand.

xmms getversion ?-session n?

Returns the xmms version number (integer).

xmms playlist ?newlist -titles -session n?

Returns a list with all the filenames (default) or titles (if ?-titles? is specified) in the current playlist. Replaces the entire playlist by the file names specified in newlist.

xmms add ?list -titles -session n?

Returns all the filenames (default) or titles (if ?-titles? is specified) in the current playlist. Appends the file names specified in list to the current playlist.

xmms addurl ?url -session n?

Adds ?url? to the current playlist.

xmms delete ?pos -session n?

Deletes the current or the playlist entry at ?pos?. NOTE: Playlist positions range from 0 to [xmms length]-1.

xmms play ?-session n?

Returns the current isplaying state. Starts/resumes playback.

xmms pause ?-session n?

Returns the current ispaused state. Pauses playback.

xmms stop ?-session n?

Returns the current isstopped state. Stops playback.

xmms previous ?-session n?

Jumps to the previous track and starts playback.

xmms next ?-session n?

Jumps to the next track and starts playback.

xmms isplaying ?-session n?

Returns the current isplaying state.

xmms ispaused ?-session n?

Returns the current ispaused state.

xmms position ?newpos -session n?

Returns the current playlist position. Set the playlist position to ?newpos?. NOTE: Playlist positions range from 0 to [xmms length]-1.

xmms length ?-session n?

Returns the number of items in the current playlist.

xmms clear ?-session n?

Deletes all items from the current playlist.

xmms time ?newtimeindex -session n?

Returns the current playback position in milliseconds. Jumps to ?newtimeindex?.

xmms duration ?position -session n? Returns the duration

of the current playlist item in milliseconds, or the duration of the playlist item at ?position?.

xmms volume ?leftchannel rightchannel -session n?

Returns a two element list with the left and the right channel volumes. Sets the playback volume for the left and right channel individualy. If only ?leftchannel? is specified, rightchannel will be set to the same level. Volumes range from 0 to 100 percent

xmms mainvolume ?level -session n?

Returns the mainvolume level. Set the mainvolume to ?level?, left and right channel will have the same value.

xmms balance ?balance -session n?

Returns the balance between the left and right channel. Balance is calculated bu subtracting the right channel level from the left channel level. Sets the balance to ?balance?.

xmms file ?pos -session n?

Returns the filename at ?pos? or the current filename.

xmms title ?pos -session n?

Returns the title at ?pos? or the current title.

xmms info ?-session n?

Returns a three element list containing the current bitrate, sample frequency and number of channels.

xmms onchange callback_proc ?-cancel -session n?

Registers a callback procedure. This procedure will be called whenever the session starts and quits, the playback state (isplaying, ispaused) changes, the playlist position, the current title changes or the current filename changes.

The callback procedure should be defined as 'proc MyCallback {args} body', the args list can be used with the 'array' command: 'array set MyArray $args' to obtain an array with the elements: session isrunning, isplaying, ispaused, title, file, duration, position and length (of the playlist). Change notification is session specific (and persists even when the specified session quits).

The callback can be unregistered by specifying ?-cancel?.

xmms eq ?list -session n?

Returns an eleven element list with the preamp setting and the ten equalizer bands. Sets the preamp and ten equalizer bands to the values in ?list?. ?list? list must have eleven floating point entries. All values range from -20 to +20.

xmms eqpreamp ?newlevel -session n?

Returns the current preamp setting. Sets the preamp level to fR?newlevel?.

xmms eqband ?band newlevel -session n?

Returns the current level for equalizer band ?band?. Sets the level for for equalizer band ?band? to fR?newlevel?.

xmms repeat ?newstate -session n?

Returns the current repeat state. Sets the repeat state to ?newstate?.

xmms shuffle ?newstate -session n?

Returns the current shuffle state. Sets the shuffle state to ?newstate?.

xmms mainwindow ?newstate -session n?

Returns the current mainwindow visibility state, 0 for invisisble, 1 for visible. Sets the state to ?newstate?. NOTE: Depending on the window manager currently in use, the user may not be able to restore the mainwindow.

xmms plwindow ?newstate -session n?

Returns the current playlist window visibility state, 0 for invisisble, 1 for visible. Sets the state to ?newstate?.

xmms eqwindow ?newstate -session n?

Returns the current equalizer window visibility state, 0 for invisisble, 1 for visible. Sets the state to ?newstate?.

xmms showpreferences ?-session n?

Opens the preferences window (does not return the current state).

xmms alwaysontop ?-session n?

Toggles the always on to state (does not return the current state).

xmms eject ?-session n?

Opens the add files dialog (does not return the current state).

xmms skin ?skinfile -session n?

Returns the current skin file. Sets the skinfile to ?skinfile?

xmms quit ?-session n?

Closes the xmms session.

KEYWORDS

Index

NAME

SYNOPSIS

DESCRIPTION

KEYWORDS