# Advanced amaroK features

## Accesos rápidos de teclado

&amarok; utiliza los accesos rápidos de forma similar a otras aplicaciones. A continuación se muestra una lista de los accesos rápidos y de sus respectivas acciones. Los accesos rápidos globales pueden configurarse pulsando con el botón derecho en la ventana del reproductor y seleccionando Configurar accesos rápidos globales... Los accesos rápidos de &amarok; pueden configurarse pulsando con el botón derecho sobre la ventana del reproductor y seleccionando Configurar accesos rápidos...

Puede hacer que sus teclas multimedia funcionen como accesos rápidos de &amarok; haciendo de su teclado un centro de control de &amarok;.

Los accesos rápidos globales son:

Combinación de teclas | Acción
--- | ---
Win X | Reproducir
Win C | Pausa
Win V | Parar
Win B | Siguiente pista
Win Z | Pista anterior
Win Tecla + del teclado numérico | Subir el volumen
Win Tecla - del teclado numérico | Bajar el volumen
Win Mayúsculas Tecla + del teclado numérico | Buscar hacia delante
Win Mayúsculas Tecla - del teclado numérico | Buscar hacia detrás
Win A | Añadir medio
Win P | Cambiar lista de reproducción
Win O | Mostrar OSD
Win M | Silenciar volumen

Los accesos rápidos de &amarok; son:

Combinación de teclas | Acción
--- | ---
Ctrl C | Copiar
Ctrl Tecla Entrar del teclado numérico | Ir a la actual
Ctrl D | Encolar pistas seleccionadas
Ctrl Q | Salir
Ctrl Mayúsculas Z | Rehacer
Ctrl S | Guardar lista de reproducción
Ctrl A | Seleccionar todo
Ctrl M | Mostrar barra de menú
Ctrl H | Barajar
Ctrl Z | Deshacer

Los accesos rápidos del Navegador de la lista de reproducción son:

Combinación de teclas | Acción
--- | ---
Espacio | Cargar lista de reproducción
F2 | Renombrar lista de reproducción
Retroceso | Eliminar lista de reproducción

## La interfaz DCOP

The amaroK DCOP interface provides you with an easy way to control amaroK with your own custom scripts.

The DCOP interface for amaroK has many generic calls that may be found in other KDE applications. This section is divided into six tables and is intended to describe the DCOP calls of the collection, contextbrowser, player, playlist, playlistbrowser and scripts. An example of the pause dcop call would look like:

&percnt;dcop amarok player pause

### dcop para la colección de amarok

Llamada DCOP | Acción
--- | ---
int totalAlbums() | Devuelve el número total de álbumes de la colección.
int totalArtists() | Devuelve el número total de artistas de la colección.
int totalCompilations() | Devuelve el número total de compilaciones de la colección.
int totalGenres() | Devuelve el número total de géneros de la colección.
int totalTracks() | Devuelve el número total de pistas de la colección.
QString query( QString sql) | Consulta la base de datos a través de SQL.
QStringList similarArtists( int artists ) | Devuelve artistas similares al de la pista actual. El límite es el valor de int artists.
void migrateFile( QString oldURL, QString newURL ) | Mueve un archivo en la colección, manteniendo las estadísticas intactas.
void scanCollection() | Explora la colección.
void scanCollectionChanges() | Explorar la colección para encontrar cambios.

### dcop para el navegador contextual de amarok

Llamada DCOP | Acción
--- | ---
void showCurrentTrack() | Muestra la pista actual del navegador contextual.
void showLyrics() | Muestra la pestaña de la letra en el navegador contextual.
void showWiki() | Muestra la pestaña wikipedia en el navegador contextual.

### dcop para el reproductor de amarok

Llamada DCOP | Acción
--- | ---
bool dynamicModeStatus() | Devuelve el estado del modo dinámico.
bool equalizerEnabled() | Devuelve el estado del ecualizador.
bool isPlaying() | Devuelve verdadero si se está reproduciendo algo.
bool randomModeStatus() | Devuelve el estado del modo aleatorio.
bool repeatPlaylistStatus() | Devuelve el estado de repetir lista.
bool repeatTrackStatus() | Devuelve el estado de repetir pista.
int getVolume() | Devuelve el volumen dentro del rango 0-100%.
int sampleRate() | Devuelve el ratio de muestra de la pista que se está reproduciendo.
int score() | Devuelve la puntuación de la pista que se está reproduciendo.
int status() | Devuelve el estado de la reproducción: 0 - detenido, 1 - parado, 2 - reproduciendo.
int trackCurrentTime() | Devuelve la posición de la pista actual en segundos.
int trackPlayCounter() | Devuelve el contador de reproducción para la pista actual.
int trackTotalTime() | Devuelve la longitud de la pista en segundos.
QString album() | Devuelve el álbum de la pista que se está reproduciendo.
QString artist() | Devuelve el artista de la pista que se está reproduciendo.
QString bitrate() | Devuelve el ratio de bits de la pista que se está reproduciendo (XX kbps).
QString comment() | Devuelve el comentario de la pista que se está reproduciendo.
QString coverImage() | Devuelve la URL codificada de la portada de la pista acutal.
QString currentTime() | Devuelve la posición de la pista que se está reproduciendo (formato [h:]mm:ss).
QString encodedURL() | Devuelve la URL codificada de la pista que se está reproduciendo.
QString engine() | Devuelve el motor de sonido.
QString genre() | Devuelve el género de la pista que se está reproduciendo.
QString lyrics() | Devuelve la letra de la pista que se está reproduciendo.
QString lyricsByPath( QString path ) | Devuelve la letra de una pista utilizando su ruta.
QString nowPlaying() | El título del medio que se está reproduciendo.
QString path() | Devuelve la ruta sin codificar de la pista que se está reproduciendo.
QString setContextStyle( QString ) | Establece el estilo CSS para el navegador contextual.
QString title() | Devuelve el titulo de la pista que se está reproduciendo.
QString totalTime() | Devuelve la longitud total de la pista que se está reproduciendo (formato [h:]mm:ss).
QString track() | Devuelve el número de pista.
QString type() | Devuelve el tipo de archivo.
QString year() | Devuelve el año de la pista que se está reproduciendo.
void configEqualizer() | Diálogo de configuración para cambiar el ecualizador.
void enableDynamicMode(bool enable) | Activa o desactiva el modo dinámico.
void enableOSD(bool enable) | Activa o desactiva la pantalla OSD.
void enableRandomMode(bool enable) | Activa o desactiva el modo aleatorio.
void enableRepeatPlaylist(bool enable) | Activa o desactiva la repetición de la lista de reproducción.
void enableRepeatTrack(bool enable) | Activa o desactiva la repetición de la pista.
void mediaDeviceMount() | Establece la orden utilizada para montar un dispositivo de medios.
void mediaDeviceUmount() | Establece la orden utilizada para desmontar un dispositivo de medios.
void mute() | Cambia el modo silencioso.
void next() | Equivalente a pulsar el botón «Siguiente».
void pause() | Equivalente a pulsar el botón «Pausa».
void play() | Equivalente a pulsar el botón «Reproducir».
void playPause() | Cambia el estado de reproducir/detener (bueno para los usuarios de teclados multimedia).
void prev() | Equivalente a pulsar el botón «Anterior».
void queueForTransfer( KURL url ) | Archivo de cola para transferir dispositivos al medio.
void seek(int s) | Se sitúa en la posición establecida en segundos.
void seekRelative(int s) | Se sitúa en la posición relativa de la pista actual.
void setEqualizer(int, int, int, int, int, int, int, int, int, int, int) | Establece las bandas del ecualizador.
void setEqualizerEnabled( bool active ) | Cambia el ecualizador.
void setEqualizerPreset( QString name ) | Establece el ecualizador preseleccionado.
void setLyricsByPath( QString url, QString lyrics ) | Establece la letra de la pista utilizando su ruta.
void setScore( int score ) | Establece la puntuación de la pista que se está reproduciendo.
void setScoreByPath( QString url, int score ) | Establece la puntuación de la pista utilizando su ruta.
void setVolume(int volume) | Establece el volumen dentro del rango 0-100%.
void showBrowser( QString browser ) | Muesta los navegadores en la ventana de la lista de reproducción.
void showOSD() | Muestra la OSD en la pantalla.
void stop() | Equivalente a pulsar el botón «Detener».
void transferDeviceFiles() | Transfiere archivos al dispositivo de medios.
void volumeDown() | Reduce el volumen un paso razonable.
void volumeUp() | Aumenta el volumen un paso razonable.

### dcop para la lista de reproducción de amarok

Llamada DCOP | Acción
--- | ---
int getActiveIndex() | Devuelve el índice de la pista actualmente activa. -1 sino hay.
int getTotalTrackCount() | Devuelve el número de pistas en la lista de reproducción. 0 sino hay.
QString saveCurrentPlaylist() | Guarda la lista de reproducción actual en current.xml y devuelve su ruta.
void addMedia( KURL ) | Añade el medio de audio especificado por la url.
void addMediaList( KURL::List ) | Añade los dispositivos de audio especificados en la url.
void clearPlaylist() | Borra la lista de reproducción.
void playByIndex(int) | Inicia la reproducción de la pista con el índice especificado.
void playMedia( KURL ) | Añade el medio de audio especificado por la url.
void popupMessage( QString) | Muestra un mensaje emergente temporal.
void removeCurrentTrack() | Elimina la pista actual de la lista de reproducción.
void repopulate() | Rellena la lista de reproducción con pistas aleatorias.
void saveM3u( QString path, bool relativePaths) | Guarda la lista de reproducción actual como m3u.
void setStopAfterCurrent( bool ) | Activa/desactiva la característica «Detener después de la pista actual».
void shortStatusMessage( QString) | Muestra temporalmente un mensaje en la barra de estado.
void shufflePlaylist() | Baraja la lista de reproducción.
void togglePlaylist() | Muestra u oculta la ventana de la lista de reproducción.

### dcop para el navegador de la lista de reproducción de amarok

Llamada DCOP | Acción
--- | ---
void addPodcast( QString ) | Añade la entrada de una emisión de audio (podcast) en el navegador de la lista de reproducción.
void scanPodcasts() | Explorar todas las emisiones de audio para actualizarlas.
void addPlaylist( QString ) | Añade una lista de reproducción al navegador de la lista de reproducción.

### dcop para los scripts de amarok

Llamada DCOP | Acción
--- | ---
bool runScript( QString name) | Inicia el script con el nombre dado. Devuelve true (verdadero) si funcionó.
bool stopScript( QString name) | Detiene el script con el nombre dado. Devuelve true (verdadero) si funcionó.
QStringList listRunningScripts() | Devuelve una lista de todos los scripts que se estén ejecutando.
void addCustomMenuItem(QString submenu, QString itemTitle ) | Activa y establece el título del elemento de menú personalizado.
void removeCustomMenuItem(QString submenu, QString itemTitle ) | Elimina el elemento del menú personalizado.
QString readConfig( QString key) | Devuelve el valor de una entrada de la configuración de Amarok de acuerdo con la clave dada.

## Opciones de la línea de órdenes

amaroK supports the use of the standard Qt and kde command line options. amaroK also has it's own application specific options.

Las opciones de Qt y kde:

Opción | Acción
--- | ---
--help | Muestra ayuda sobre las opciones.
--help-qt | Muestra ayuda sobre las opciones específicas de Qt.
--help-kde | Muestra opciones específicas de KDE.
--help-all | Muestra todas las opciones.
--author | Muestra información sobre el autor.
-v, --version | Muestra información sobre la versión.
--license | Muestra información sobre la licencia.

The amaroK options:

Las opciones de &amarok; están diseñadas para utilizarse mientras &amarok; se está ejecutando.

Opción | Acción
--- | ---
-r, --previous | Va a la pista anterior en la lista de reproducción.
-p, --play | Inicia la reproducción de la lista de reproducción actual.
-s, --stop | Detiene la reproducción.
--pause | Detiene la reproducción.
-f, --next | Va a la siguiente pista en la lista de reproducción.
-a, --append | Añade archivos/URLs a la lista de reproducción.
-e, --enqueue | Consulte «append». Disponible por razones de compatibilidad.
--queue | Encola los archivos/URLs después de la pista que se está reproduciendo.
-m, --toggle-playlist-window | Muestra u oculta la ventana de la lista de reproducción.
--wizard | Inicia el asistente de primera ejecución.
--engine "nombre" | Inicia &amarok; con el motor «nombre».

## Escribir un script

Los scripts permiten extender &amarok; con facilidad sin cambiar el código base principal. Los scripts son similares a las extensiones, pero en lugar de tener una API de extensiones dedicada utiliza la interfaz DCOP de &amarok; para comunicarse. Éste hace posible la escritura de scripts en la mayor parte de los lenguajes de programación, como Ruby, Python o PHP. No solo puede crear scripts en los clásicos lenguajes de scripts, sino también en lenguajes compilados como C++ o C plano. Además, &amarok; puede notificar los scripts para ciertos eventos y reaccionar de forma acorde. Este sistema de notificación se explicará posteriormente en esta sección.

### Interfaces

Es posible escribir scripts simples que no necesiten interacción del usuario, y también es posible crear scripts con GUIs confortables que actúan como pequeñas aplicaciones independientes. Para la programación de GUI se pueden utilizar muchas de las interfaces que proporciona KDE, por ejemplo RubyQt, una biblioteca QT de interfaces para Ruby. Sin embargo, debe tener en cuenta que no todos los usuarios tienen todas las interfaces instaladas. Si decide utilizar una interfaz, pruebe a utilizar una de las más usadas (p.ej. RubyQt o PyQt).

Para provocar alguna reacción cuando falla la ejecución de un scripts por culpa de que falta una dependencia, compruebe si el módulo que desea incluir en su script existe. Si falta la dependencia, debería capturar el error y mostrar un diálogo con información utilizando la herramienta de la línea de órdenes «kdialog», de forma que el usuario sepa porqué falló la ejecución del script.

Este ejemplo muestra la captura de una dependencia que falta en Ruby:

    begin
           require 'Korundum'
    rescue LoadError
           error = 'Este script necesita Korundum (interfaz de KDE para ruby) que se encuentra en kdebindings v3.4.'
           `kdialog --sorry '#{error}'`
           exit
    end

### Comenzando: Los modelos

&amarok; proporciona scripts modelo para varios lenguajes en el directorio `scripts/templates/`. Puede utilizar estos scripts como base para sus propios scripts, y extenderlo con la funcionalidad que necesite. Verá que la programación es bastante intuitiva. Por ejemplo, si sabe programar un poquito en Python, hacer su propio script no le tomará mucho tiempo.

### Controlar &amarok; con DCOP

Scripts can control amaroK by calling some of its DCOP functions. The easiest way to invoke a DCOP function is by using the "dcop" command line utility, which is part of every KDE distribution.

Veamos un ejemplo para incrementar el volumen:

    dcop amarok player volumeUp

La mayor parte de los lenguajes de script permiten ejecutar programas externos, con una función como exec(). De esta forma la utilidad «dcop» puede llamarse fácilmente. Veamos un ejemplo simple en Python:

    import os
     os.system("dcop amarok player volumeDown")

### Notificaciones

&amarok; envía notificaciones a todos los scripts en ejecución escribiendo cadenas en el canal de la entrada estándar stdin. No obstante el script debería estar escuchando constantemente en stdin, para poder reaccionar de acuerdo con cada uno de los posibles eventos. Los scripts también pueden decidir ignorar cualquier evento que no necesiten.

&amarok; envía las siguientes notificaciones:

    configure
    Tells the script to show its configuration dialog. The script must handle the
    storing and loading of configuration options by itself. When a script is
    started, amaroK sets its working directory to the folder where all data
    should be stored.

    engineStateChange:empty|idle|paused|playing
    Asigna un cambio en el estado del motor.

    trackChange
    Asigna el inicio de una nueva pista. El script puede utilizar las funciones DCOP para
    pedir más información sobre la pista, p.ej. metadatos y longitud.

    volumeChangenuevoVolumen
    Establece un cambio en el nivel del volumen. El volumen es un entero con
    un rango de entre 0 y 100.

    customMenuClicked:submenú títuloElemento rutas
    Devuelve las rutas de los archivos seleccionados en la lista de reproducción
    cuando se pulse el elemento del menú contextual El submenú y el
    títuloElemento se devuelven para identificar los propósitos en el caso
    de que el script estuviera esperando varias notificaciones.
    Para insertar un elemento en el menú contextual utilice la llamada DCOP
    «dcop amarok script addCustomMenuItem( submenú títuloElemento )». Para eliminar un
    elemento del menú contextual utilice la llamada DCOP
    «dcop amarok script removeCustomMenuItem( submenú títuloElemento )».

### Terminación del script

Antes de salir de &amarok;, o cuando se detiene el script con el Gestor de scritps, &amarok; envía la señal SIGTERM al script. La señal debe capturarse para hacer un trabajo limpio, permitiendo guardar los datos o la configuración.

### Empaquetado

&amarok;'s Script Manager is able to install script packages that the user has downloaded from a web server. Packages are just normal tarballs (.tar), optionally compressed with bzip2 (.bz2). We strongly recommend using a filename like myscript.amarokscript.tar.bz2, so the user can easily identify the package as an amaroK script.

&amarok; 1.3 solo aceptará paquetes de script con la extensión amarokscript, por tanto, es mejor utilizarlo para comenzar.

El contenido del paquete comprimido debe estar organizado de la siguiente forma:

    miscript/
       README
       miscript.py (ejecutable)
       algunmodulo.py
       foo.data
       ...

### Permisos de los archivos

El script principal deber tener permisos de ejecución (+x), mientras que los módulos adicionales que cargue el script no deberían tener permisos de ejecución. Para preservar los permisos del archivo en el archivo comprimido, debería utilizar el parámetro -p.

    tar -cf miscript.amarokscript.tar -p miscript

&amarok; no podrá instalar el script si los permisos no están correctamente establecidos.

### Distribución

Cuando finalice el paquete, puede subirlo a www.kde-apps.org, y añadir el enlace a la página wiki de scripts de &amarok;. Para introducir la entrada en kde-apps debería utilizar la categoría Scripts de &amarok;.