DCOP-Grænsefladen

amaroK's DCOP-grænseflade giver dig en nem måde at kontrollere amaroK med dine hjemmelavede scripter.

DCOP-grænsefladen for amaroK har mange generiske kald der kan findes i andre af KDE's programmer. Dette afsnit er opdelt i seks tabeller og er beregnet til at beskrive DCOP-kald for samling, sammenhængsbrowser, afspiller, spilleliste, spillelistebrowser og scripter. Et eksempel på “pause” dcop-kaldet ville se sådan ud:

%dcop amarok player pause

dcop amarok-samling

DCOP-kaldHandling
int totalAlbums()Returnerer det totale antal albummer i samlingen.
int totalArtists()Returnerer det totale antal kunstnere i samlingen.
int totalCompilations()Returnerer det totale antal samlingsalbum i samlingen.
int totalGenres()Returnerer det totale antal genrer i samlingen.
int totalTracks()Returnerer det totale antal spor i samlingen.
QString query( QString sql)Sender en forespørgsel til databasen via SQL.
QStringList similarArtists( int kunstnere )Returnerer lignende kunstnere som det nuværende spor, begrænset til antal givet af kunstnere.
void migrateFile( QString gammel_url, QString ny_url )Flyt en fil i samlingen, og behold statistikken intakt.
void scanCollection()Gennemsøg samlingen.
void scanCollectionChanges()Søg kun gennem samlingen efter ændringer.

dcop amarok contekstbrowser

DCOP-kaldHandling
void showCurrentTrack()Vis det nuværende spor i sammenhængsbrowseren.
void showLyrics()Vis sangtekstfanebladet i sammenhængsbrowseren.
void showWiki()Vis Wikipedia-fanebladet i sammenhængsbrowseren.

dcop amarok player

DCOP-kaldHandling
bool dynamicModeStatus()Returnér status for dynamisk tilstand.
bool equalizerEnabled()Returnér status for equalizeren.
bool isPlaying()Returnér sand hvis noget spilles nu.
bool randomModeStatus()Returnér status for tilfældig tilstand
bool repeatPlaylistStatus()Returnér status for gentagelse af spillelisten.
bool repeatTrackStatus()Returnér status for gentagelse af spor.
int getVolume()Returnér lydstyrke i intervallet 0 - 100 %.
int sampleRate()Returnér samplingsfrekvensen for sporet som for øjeblikket spilles.
int score()Returnér scoring for sporet som for øjeblikket spilles.
int status()Returnér afspilningsstatus: 0 - stoppet, 1 - pause, 2 - spiller.
int trackCurrentTime()Returnerer nuværende afspilningsposition i sekunder.
int trackPlayCounter()Returnerer afspilningstælleren for nuværende sang.
int trackTotalTime()Returnerer sporlængden i sekunder.
QString album()Returnér albummet for sporet som for øjeblikket spilles.
QString artist()Returnér kunstneren for sporet som for øjeblikket spilles.
QString bitrate()Returnér bithastigheden for sporet som for øjeblikket spilles (i kilobit pr sekund).
QString comment()Returnér kommentaren for sporet som for øjeblikket spilles.
QString coverImage()Returnér den indkodede url for nuværende spors omslag
QString currentTime()Returnér positionen for sporet som for øjeblikket spilles (i formatet [t:]mm:ss).
QString encodedURL()Returnér den indkodede url for sporet som for øjeblikket spilles.
QString engine()Returnér nuværende lydgrænseflade.
QString genre()Returnér genren for sporet som for øjeblikket spilles.
QString lyrics()Returnér sangteksten for sporet som for øjeblikket spilles.
QString lyricsByPath( QString søgesti )Returnér sangtekst for et spor ifølge søgesti.
QString nowPlaying()Titlen på det medium som nu spilles.
QString path()Returnér den ikke-indkodede søgesti for sporet som for øjeblikket spilles.
QString setContekstStyle( QString )Indstil CSS-stilen for sammenhængsbrowseren.
QString title()Returnér titlen for sporet som for øjeblikket spilles.
QString totalTime()Returnér den totale længde for sporet som for øjeblikket spilles (i formatet [t:]mm:ss).
QString track()Returnér spornummeret.
QString type()Returnér filtypen.
QString year()Returnér året for sporet som for øjeblikket spilles.
void configEqualizer()Skift equalizerens indstillingsdialog.
void enableDynamicMode(bool aktivér)Slå dynamisk tilstand til og fra.
void enableOSD(bool aktivér)Slå skærmmeddelelser til og fra.
void enableRandomMode(bool aktivér)Slå tilfældigt tilstand til og fra.
void enableRepeatPlaylist(bool aktivér)Slå gentagelse af spilleliste til og fra.
void enableRepeatTrack(bool aktivér)Slå gentagelse af spor til og fra.
void mediaDeviceMount()Indstiller kommandoen som bruges til at montere medieenheder.
void mediaDeviceUmount()Indstiller kommandoen som bruges til at afmontere medieenheder.
void mute()Slå lyd til og fra.
void next()Svarer til at klikke på knappen "Næste".
void pause()Svarer til at klikke på knappen "Pause".
void play()Svarer til at klikke på knappen "Spil".
void playPause()Skift tilstand mellem at spille og holde pause (godt for brugere af multimedietastatur)
void prev()Svarer til at klikke på knappen "Foregående".
void queueForTransfer( KURL url )Sæt filer i kø for overførsel til medieenheden.
void seek(int s)Søg i sporet til positionen i sekunder.
void seekRelative(int s)Søg til en position i forhold til sporets nuværende position.
void setEqualizer(int, int, int, int, int, int, int, int, int, int, int)Indstil equalizerens bånd
void setEqualizerEnabled( bool active )Slå equalizeren til og fra.
void setEqualizerPreset( QString navn )Indstil equalizerens forudindstilling
void setLyricsByPath( QString url, QString sangtekst )Indstil sangtekst for et spor ifølge dets søgesti.
void setScore( int scoring )Indstil scoring for sporet som for øjeblikket spilles.
void setScoreByPath( QString url, int scoring )Indstil scoring for et spor ifølge dets søgesti.
void setVolume(int lydstyrke)Indstil lydstyrke i intervallet 0 - 100 %
void showBrowser( QString browser )Viser browserne i spillelistens vindue.
void showOSD()Vis skærmmeddelelser på skærmen.
void stop()Svarer til at klikke på knappen "Stop".
void transferDeviceFiles()Overfør filer til medieenheden.
void volumeDown()Mindsk lydstyrke med et rimeligt skridt.
void volumeUp()Øg lydstyrke med et rimeligt skridt.

dcop amarok playlist

DCOP-kaldHandling
int getActiveIndex()Returnér indeks for sporet som for øjeblikket er aktivt. -1 hvis intet.
int getTotalTrackCount()Returnér antal spor i spillelisten. 0 hvis ingen.
QString saveCurrentPlaylist()Gemmer den nuværende spilleliste i nuværende.xml og og returnerer dens søgesti.
void addMedia( KURL )Tilføj lydmedium angivet af url'en.
void addMediaList( KURL::List )Tilføj et lydmedie angivet af url'en.
void clearPlaylist()Rydder spillelisten.
void playByIndex(int)Begynder at afspille sporet med angivet indeks.
void playMedia( KURL )Tilføj lydmedium angivet af url'en.
void popupMessage( QString)Viser en midlertidig skærmmeddelelse.
void removeCurrentTrack()Fjerner nuværende spor fra spillelisten.
void repopulate()Fyld i spillelisten ind igen med tilfældige spor.
void saveM3u( QString søgesti, bool relativ_søgesti)Gemmer nuværende spilleliste som m3u.
void setStopAfterCurrent( bool )Aktiverer eller deaktiverer funktionen "Stop efter dette spor".
void shortStatusMessage( QString)Viser en midlertidig meddelelse på statuslinjen.
void shufflePlaylist()Blander spillelisten.
void togglePlaylist()Slå spillelistens vindue til og fra.

dcop amarok playlistbrowser

DCOP-kaldHandling
void addPodcast( QString )Tilføj en podradioudsendelse til spillelistebrowseren.
void scanPodcasts()Søg gennem alle podradioudsendelser efter opdateringer.
void addPlaylist( QString )Tilføj en spilleliste til spillelistebrowseren.

dcop amarok script

DCOP-kaldHandling
bool runScript( QString navn)Starter scriptet med angivet navn. Returnerer sandt hvis det lykkes.
bool stopScript( QString navn)Stopper scriptet med angivet navn. Returnerer sandt hvis det lykkes.
QStringList listRunningScripts()Returnerer en liste med scripter som for øjeblikket kører.
void addCustomMenuItem(QString undermenu, QString punkttitel )Aktiverer og indstiller titlen for eget menupunkt.
void removeCustomMenuItem(QString undermenu, QString punkttitel )Fjerner det egne menupunkt.
QString readConfig( QString nøgle)Returnerer værdien af en indstillingsindgang fra AmarokConfig for angiven nøgle.