path: root/src/dbus/aud-dbus.xml

<?xml version="1.0" encoding="UTF-8" ?>

<!--
 * aud-dbus.xml
 * Copyright 2007-2014 Ben Tucker, Yoshiki Yazawa, Matti Hämäläinen, and
 *                     John Lindgren
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions, and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions, and the following disclaimer in the documentation
 *    provided with the distribution.
 *
 * This software is provided "as is" and without any warranty, express or
 * implied. In no event shall the authors be liable for any damages arising from
 * the use of this software.
 -->

<node name="/">
    <!-- Audacious General Information -->
    <interface name="org.atheme.audacious">
        <!-- Audacious version -->
        <method name="Version">
            <arg type="s" direction="out" name="version"/>
        </method>

        <!-- Quit Audacious -->
        <method name="Quit" />

        <!-- Open files (Eject) -->
        <method name="Eject" />

        <!-- Main window visibility -->
        <method name="MainWinVisible">
            <arg type="b" direction="out" name="is_main_win"/>
        </method>

        <!-- Toggle main window visibility -->
        <method name="ShowMainWin">
            <arg type="b" direction="in" name="show"/>
        </method>

        <!-- Get names of available 'standard' tuple fields -->
        <method name="GetTupleFields">
            <!-- Return array of tuple field names -->
            <arg type="as" direction="out" name="fields"/>
        </method>

        <!-- Playback Information/Manipulation -->
        <!-- Begin or resume playback -->
        <method name="Play" />

        <!-- Pause playback -->
        <method name="Pause" />

        <!-- Stop playback -->
        <method name="Stop" />

        <!-- Is playback playing? -->
        <method name="Playing">
            <!-- Return true if playing, false otherwise -->
            <arg type="b" direction="out" name="is_playing"/>
        </method>

        <!-- Is playback paused? -->
        <method name="Paused">
            <!-- Return true if paused, false otherwise -->
            <arg type="b" direction="out" name="is_paused"/>
        </method>

        <!-- Is playback stopped? -->
        <method name="Stopped">
            <!-- Return true if stopped, false otherwise -->
            <arg type="b" direction="out" name="is_stopped"/>
        </method>

        <!-- What is the playback status? -->
        <method name="Status">
            <!-- Return the status as a string: -->
            <!-- one of {"playing" "paused" "stopped"} -->
            <arg type="s" direction="out" name="status"/>
        </method>

        <!-- What is the bitrate, frequency, and number of channels of the -->
        <!-- current audio format? -->
        <method name="Info">
            <arg type="i" direction="out" name="rate"/>
            <arg type="i" direction="out" name="freq"/>
            <arg type="i" direction="out" name="nch"/>
        </method>

        <!-- What is the current output position? -->
        <method name="Time">
            <!-- Position of song, in ms -->
            <arg type="u" direction="out" name="time"/>
        </method>

        <!-- Seek to some absolute position in the current song -->
        <method name="Seek">
            <!-- Position of song, in ms, to seek to -->
            <arg type="u" direction="in" name="pos"/>
        </method>

        <!-- What is the playback volume? -->
        <method name="Volume">
            <!-- Volume of the left channel -->
            <arg type="i" direction="out" name="vl"/>
            <!-- Volume of the right channel -->
            <arg type="i" direction="out" name="vr"/>
        </method>

        <!-- Set the playback volume -->
        <method name="SetVolume">
            <!-- Volume of the left channel -->
            <arg type="i" direction="in" name="vl"/>
            <!-- Volume of the right channel -->
            <arg type="i" direction="in" name="vr"/>
        </method>

        <!-- Get the playback balance -->
        <method name="Balance">
            <!-- Balance between left and right channels -->
            <arg type="i" direction="out" name="balance"/>
        </method>

        <!-- Playlist Information/Manipulation -->
        <!-- Playlist position -->
        <method name="Position">
            <!-- Return position of current song in current playlist -->
            <arg type="u" direction="out" name="pos"/>
        </method>

        <!-- Skip ahead one song in the current playlist -->
        <method name="Advance" />

        <!-- Skip backwards one song in the current playlist -->
        <method name="Reverse" />

        <!-- Playlist length -->
        <method name="Length">
            <!-- Return length of current playlist -->
            <arg type="i" direction="out" name="length"/>
        </method>

        <!-- Get a song's title -->
        <method name="SongTitle">
            <!-- Song position in the playlist -->
            <arg type="u" direction="in" name="pos"/>

            <!-- Return title of desired song -->
            <arg type="s" direction="out" name="title"/>
        </method>

        <!-- Get a song's filename -->
        <method name="SongFilename">
            <!-- Song position in the playlist -->
            <arg type="u" direction="in" name="pos"/>

            <!-- Return filename of desired song -->
            <arg type="s" direction="out" name="filename"/>
        </method>

        <!-- Get the length of some song, in seconds -->
        <method name="SongLength">
            <!-- Song position in the playlist -->
            <arg type="u" direction="in" name="pos"/>

            <!-- Return length, in seconds, of desired song -->
            <arg type="i" direction="out" name="length"/>
        </method>

        <!-- Get the length of some song, in frames -->
        <method name="SongFrames">
            <!-- Song position in the playlist -->
            <arg type="u" direction="in" name="pos"/>

            <!-- Return length, in frames, of desired song -->
            <arg type="i" direction="out" name="length"/>
        </method>

        <!-- Get the value of a tuple field of some song -->
        <method name="SongTuple">
            <!-- Song position in the playlist -->
            <arg type="u" direction="in" name="pos"/>

            <!-- Tuple name -->
            <arg type="s" direction="in" name="tuple"/>

            <!-- Return tuple value -->
            <arg type="v" direction="out" name="value"/>
        </method>

        <!-- Jump to some position in the playlist -->
        <method name="Jump">
            <!-- Song position to jump to -->
            <arg type="u" direction="in" name="pos"/>
        </method>

        <!-- Add some file to the current playlist -->
        <method name="Add">
            <!-- File to add -->
            <arg type="s" direction="in" name="file"/>
        </method>

        <!-- Add some URL to the current playlist -->
        <method name="AddUrl">
            <!-- URL to add -->
            <arg type="s" direction="in" name="url"/>
        </method>

        <!-- Add a list of files -->
        <method name="AddList">
            <!-- Array of filenames to add -->
            <arg type="as" direction="in" name="filenames"/>
        </method>

        <!-- Open a list of files -->
        <method name="OpenList">
            <!-- Array of filenames to open -->
            <arg type="as" direction="in" name="filenames"/>
        </method>

        <!-- Open a list of files in a temporary playlist -->
        <method name="OpenListToTemp">
            <!-- Array of filenames to open -->
            <arg type="as" direction="in" name="filenames"/>
        </method>

        <!-- Delete some song from the playlist -->
        <method name="Delete">
            <!-- Position of song to delete -->
            <arg type="u" direction="in" name="pos"/>
        </method>

        <!-- Clear the playlist -->
        <method name="Clear" />

        <!-- Query auto-advance status -->
        <method name="AutoAdvance">
            <arg type="b" direction="out" name="is_advance"/>
        </method>

        <!-- Toggle auto-advance -->
        <method name="ToggleAutoAdvance" />

        <!-- Query repeat status -->
        <method name="Repeat">
            <arg type="b" direction="out" name="is_repeat"/>
        </method>

        <!-- Toggle repeat -->
        <method name="ToggleRepeat" />

        <!-- Query shuffle status -->
        <method name="Shuffle">
            <arg type="b" direction="out" name="is_shuffle"/>
        </method>

        <!-- Toggle shuffle -->
        <method name="ToggleShuffle" />

        <!-- Query stop-after-song status -->
        <method name="StopAfter">
            <arg type="b" direction="out" name="is_stopping"/>
        </method>

        <!-- Toggle stop-after-song -->
        <method name="ToggleStopAfter" />

        <!-- Show preferences window -->
        <method name="ShowPrefsBox">
            <arg type="b" direction="in" name="show"/>
        </method>

        <!-- Show about window -->
        <method name="ShowAboutBox">
            <arg type="b" direction="in" name="show"/>
        </method>

        <!-- Show jump to file window -->
        <method name="ShowJtfBox">
            <arg type="b" direction="in" name="show"/>
        </method>

        <!-- Show filebrowser -->
        <method name="ShowFilebrowser">
            <arg type="b" direction="in" name="show"/>
        </method>

        <!-- Either play or pause -->
        <method name="PlayPause" />

        <!-- Playqueue get playlist pos -->
        <method name="QueueGetListPos">
            <arg type="u" direction="in" name="qpos"/>
            <arg type="u" direction="out" name="pos"/>
        </method>

        <!-- Playqueue get playqueue pos -->
        <method name="QueueGetQueuePos">
            <arg type="u" direction="in" name="pos"/>
            <arg type="u" direction="out" name="qpos"/>
        </method>

        <!-- Get Info -->
        <method name="GetInfo">
            <arg type="i" direction="out" name="rate"/>
            <arg type="i" direction="out" name="freq"/>
            <arg type="i" direction="out" name="nch"/>
        </method>

        <method name="GetPlayqueueLength">
            <arg type="i" direction="out" name="length"/>
        </method>

        <method name="PlaylistInsUrlString">
            <arg type="s" direction="in" name="url"/>
            <arg type="i" direction="in" name="pos"/>
        </method>

        <method name="PlaylistAdd">
            <arg type="s" direction="in" name="list"/>
        </method>

        <method name="PlayqueueAdd">
            <arg type="i" direction="in" name="pos"/>
        </method>

        <method name="PlayqueueRemove">
            <arg type="i" direction="in" name="pos"/>
        </method>

        <method name="PlayqueueClear" />

        <method name="PlayqueueIsQueued">
            <arg type="i" direction="in" name="pos"/>
            <arg type="b" direction="out" name="is_queued"/>
        </method>

        <method name="PlaylistEnqueueToTemp">
            <arg type="s" direction="in" name="url"/>
        </method>

        <!-- equalizer -->
        <method name="GetEq">
            <arg type="d" direction="out" name="preamp"/>
            <arg type="ad" direction="out" name="bands"/>
        </method>

        <method name="GetEqPreamp">
            <arg type="d" direction="out" name="preamp"/>
        </method>

        <method name="GetEqBand">
            <arg type="i" direction="in" name="band"/>
            <arg type="d" direction="out" name="value"/>
        </method>

        <method name="SetEq">
            <arg type="d" direction="in" name="preamp"/>
            <arg type="ad" direction="in" name="bands"/>
        </method>

        <method name="SetEqPreamp">
            <arg type="d" direction="in" name="preamp"/>
        </method>

        <method name="SetEqBand">
            <arg type="i" direction="in" name="band"/>
            <arg type="d" direction="in" name="value"/>
        </method>

        <!-- Activate/Deactivate Equalizer -->
        <method name="EqualizerActivate">
            <arg type="b" direction="in" name="active"/>
        </method>

        <method name="NumberOfPlaylists">
            <arg type="i" direction="out" name="count" />
        </method>

        <method name="GetActivePlaylist">
            <arg type="i" direction="out" name="plnum" />
        </method>

        <method name="SetActivePlaylist">
            <arg type="i" direction="in" name="plnum" />
        </method>

        <method name="GetActivePlaylistName">
            <arg type="s" direction="out" name="plname" />
        </method>

        <method name="SetActivePlaylistName">
            <arg type="s" direction="in" name="plname" />
        </method>

        <method name="NewPlaylist" />

        <method name="DeleteActivePlaylist" />

        <method name="PlayActivePlaylist" />

    </interface>
</node>