[Top] | [Contents] | [Index] | [ ? ] |
This manual documents PyXMMS-remote (version 1.12, 7 February 2005), a command-line interface to XMMS.
Introduction | ||
1. How to use this program | ||
2. Command reference | ||
3. Environment variables | ||
4. Setup tips | ||
A. GNU GENERAL PUBLIC LICENSE | ||
Index | ||
-- The Detailed Node Listing --- | ||
---|---|---|
Command reference | ||
2.1 Commands from libxmms | ||
2.2 Commands specific to PyXMMS | ||
Setup tips | ||
4.1 Midnight commander | ||
4.2 MIME support | ||
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
PyXMMS-remote is a Python program using PyXMMS to control an XMMS session. PyXMMS-remote is free software. PyXMMS-remote is licensed under the GNU GPL version 2.
Notes:
With PyXMMS-remote, you can tell or retrieve quite a lot of things to/from an XMMS session with shell commands (or shell scripts or whatever you want, but if what you want to do is really complex, you'd better use PyXMMS directly).
The following command tells the XMMS session 0 (default) to start playing the current playlist entry:
pyxmms-remote play |
The following command tells the XMMS session number 2 to stop playing:
pyxmms-remote -s 2 stop |
Here is a way to:
pyxmms-remote E entry... |
equivalent to the not-so-short following command:
pyxmms-remote enqueue_and_play_launch_if_session_not_started entry... |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The general form of a valid invocation of PyXMMS-remote is:
pyxmms-remote [option]... command [command_argument]... |
where the valid options are:
-s session
--session=session
-p program
--program=program
--poll-delay=delay
delay must be a non-negative floating-point number.
--timeout=timeout
timeout must be a non-negative floating-point number.
-f decimals
--floats-precision=decimals
--help
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
2.1 Commands from libxmms | ||
2.2 Commands specific to PyXMMS |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following commands are direct bindings to the `xmms_remote_*' functions of libxmms.
enqueue should be a boolean (0 = false, 1 = true); false does not work in XMMS 1.2.6.
Note: at least in XMMS 1.2.7, the resolution seems to be 1 second although the time to jump to is given in milliseconds.
The code fragment that answers this request in XMMS 1.2.6 is:
case CMD_GET_VERSION: ctrl_write_gint(pkt->fd, 0x09a3); ... |
I suspect it is the version of the protocol in use through the XMMS control socket (which is how libxmms talks to XMMS, by the way). If you understand this better than I, please let me know.
playlist
and play
instead.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following commands are bindings to functions of PyXMMS which are not defined in libxmms--but very likely to be implemented with functions of libxmms.
a file_or_url...
playlist_add_allow_relative file_or_url...
e file_or_url...
enqueue_and_play file_or_url...
E file_or_url...
enqueue_and_play_launch_if_session_not_started file_or_url...
fade_out [action [nb_steps [step_duration [restore_volume]]]]
action
stop
and pause
. Default is stop
.
nb_steps
step_duration
restore_volume
1
to have the volume restored and 0
to have it
remain at 0. Default is 1
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
There is currently one environment variable specific to PyXMMS-remote: PYXMMS_REMOTE_XMMS_PRG. This sets the XMMS executable name (absolute or relative) just as the `-p' option.
Note: command-line options take precedence over environment variables.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
4.1 Midnight commander | ||
4.2 MIME support |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
You can use a rule like:
regex/\.([mM][pP]3|[oO][gG][gG]|[mM]3[uU])$ Open=pyxmms-remote E %s View=pyxmms-remote E %s Icon=sound.xpm |
in your `~/.mc/bindings' (personal) or `/etc/mc/mc.ext' (system-wide, and might be located elsewhere in your system--this is the Debian location).
This way, you will enqueue and play (as well as launch XMMS before if necessary) the selected file(s) when you press Enter or F3.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
You can associate a PyXMMS-remote invocation with the MIME types "application/ogg" (cf. RFC 3534), "application/x-ogg" (used when "application/ogg" was not yet registered as an official MIME type), "audio/mpeg" and "audio/x-mpegurl". On a Debian system (with the mime-support package), this can be done with the following lines in your `~/.mailcap' or the system-wide `/etc/mailcap' (if for some reason you did not install the Debian package for PyXMMS-remote):
application/ogg; pyxmms-remote E "%s"; test=test -n "$DISPLAY" application/x-ogg; pyxmms-remote E "%s"; test=test -n "$DISPLAY" audio/mpeg; pyxmms-remote E "%s"; test=test -n "$DISPLAY" audio/x-mpegurl; pyxmms-remote E "%s"; test=test -n "$DISPLAY" |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Copyright © 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version," you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
one line to give the program's name and an idea of what it does. Copyright (C) 19yy name of author This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. |
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 20yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. |
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice |
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Jump to: | C E G I L P R S X |
---|
Jump to: | C E G I L P R S X |
---|
[Top] | [Contents] | [Index] | [ ? ] |
The one specified with the `--session' option.
[Top] | [Contents] | [Index] | [ ? ] |
Introduction
1. How to use this program
2. Command reference
2.1 Commands from libxmms3. Environment variables
2.2 Commands specific to PyXMMS
4. Setup tips
4.1 Midnight commanderA. GNU GENERAL PUBLIC LICENSE
4.2 MIME support
PreambleIndex
How to Apply These Terms to Your New Programs
[Top] | [Contents] | [Index] | [ ? ] |
Introduction
1. How to use this program
2. Command reference
3. Environment variables
4. Setup tips
A. GNU GENERAL PUBLIC LICENSE
Index
[Top] | [Contents] | [Index] | [ ? ] |
Button | Name | Go to | From 1.2.3 go to |
---|---|---|---|
[ < ] | Back | previous section in reading order | 1.2.2 |
[ > ] | Forward | next section in reading order | 1.2.4 |
[ << ] | FastBack | beginning of this chapter or previous chapter | 1 |
[ Up ] | Up | up section | 1.2 |
[ >> ] | FastForward | next chapter | 2 |
[Top] | Top | cover (top) of document | |
[Contents] | Contents | table of contents | |
[Index] | Index | concept index | |
[ ? ] | About | this page |
where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure: