annotate src/audacious/objects.xml @ 2731:f4a5f8fa3836 trunk

[svn] Added stubs in audctrl.c for the unimplemented functions defined in audctrl.h. Fixed audtool by moving all the DBus methods defined in objects.xml to a common interface; this will be decentralized for MPRIS. Modified the Makefile so that libaudclient is built after audacious to eliminates a build warning.

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

<!--
 - Audacious: A cross-platform multimedia player
 - Copyright (c) 2007 Ben Tucker
 -
 - 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; under version 2 of the License.
 -
 - 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., 51 Franklin Street, Fifth Floor, Boston, MA
 - 02110-1301, USA.
 -->

<!--
    Defined:
    CMD_GET_VERSION
    CMD_PLAY
    CMD_PAUSE
    CMD_STOP
    CMD_IS_PLAYING
    CMD_GET_PLAYLIST_POS
    CMD_SET_PLAYLIST_POS
    CMD_GET_PLAYLIST_LENGTH
    CMD_PLAYLIST_CLEAR
    CMD_GET_OUTPUT_TIME
    CMD_JUMP_TO_TIME
    CMD_GET_PLAYLIST_FILE
    CMD_GET_PLAYLIST_TITLE
    CMD_GET_PLAYLIST_TIME
    CMD_PLAYLIST_PREV
    CMD_PLAYLIST_NEXT
    CMD_TOGGLE_REPEAT
    CMD_TOGGLE_SHUFFLE
    CMD_PLAYLIST_ADD_URL_STRING
    CMD_PLAYLIST_DELETE
    CMD_IS_REPEAT
    CMD_IS_SHUFFLE


    Remaining:
    CMD_PLAYLIST_ADD
    CMD_GET_VOLUME
    CMD_SET_VOLUME
    CMD_GET_SKIN
    CMD_SET_SKIN
    CMD_GET_INFO
    CMD_GET_EQ_DATA
    CMD_SET_EQ_DATA
    CMD_PL_WIN_TOGGLE
    CMD_EQ_WIN_TOGGLE
    CMD_SHOW_PREFS_BOX
    CMD_TOGGLE_AOT
    CMD_SHOW_ABOUT_BOX
    CMD_EJECT
    CMD_GET_BALANCE
    CMD_MAIN_WIN_TOGGLE
    CMD_IS_EQ_WIN
    CMD_IS_PL_WIN
    CMD_IS_MAIN_WIN
    CMD_GET_EQ
    CMD_GET_EQ_PREAMP
    CMD_GET_EQ_BAND
    CMD_SET_EQ
    CMD_SET_EQ_PREAMP
    CMD_SET_EQ_BAND
    CMD_QUIT
    CMD_PLAYLIST_INS_URL_STRING
    CMD_PLAYLIST_INS
    CMD_PLAY_PAUSE
    CMD_PLAYQUEUE_ADD
    CMD_GET_PLAYQUEUE_LENGTH
    CMD_PLAYQUEUE_REMOVE
    CMD_TOGGLE_ADVANCE
    CMD_IS_ADVANCE
    CMD_ACTIVATE
    CMD_SHOW_JTF_BOX
    CMD_PLAYQUEUE_CLEAR
    CMD_PLAYQUEUE_IS_QUEUED
    CMD_PLAYQUEUE_GET_POS
    CMD_PLAYQUEUE_GET_QPOS
    CMD_PLAYLIST_ENQUEUE_TO_TEMP
    CMD_PLAYLIST_GET_TUPLE_DATA
-->

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

        <!-- Playback Information/Manipulation -->
        <!-- Begin or resume playback -->
        <method name="Play">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

        <!-- Pause playback -->
        <method name="Pause">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

        <!-- Stop playback -->
        <method name="Stop">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

        <!-- 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 current output position? -->
        <method name="Time">
            <!-- Position of song, in ms -->
            <arg type="i" direction="out" name="time"/>
        </method>

        <!-- Seek to some absolute position in the current song -->
        <method name="Seek">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
            <!-- Position of song, in ms, to seek to -->
            <arg type="i" name="pos"/>

            <!-- Return true on success, or false if position out of range? -->
            <!-- <arg type="b" direction="out"/> -->
        </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">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
            <!-- Volume of the left channel -->
            <arg type="i" name="vl"/>
            <!-- Volume of the right channel -->
            <arg type="i" 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="i" direction="out" name="pos"/>
        </method>

        <!-- Skip ahead one song in the current playlist -->
        <method name="Advance">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

        <!-- Skip backwards one song in the current playlist -->
        <method name="Reverse">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

        <!-- 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="i" 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="i" 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="i" 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="i" name="pos"/>

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

        <!-- Jump to some position in the playlist -->
        <method name="Jump">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
            <!-- Song position to jump to -->
            <arg type="i" name="pos"/>
        </method>

        <!-- Add some URL to the current playlist -->
        <method name="AddUrl">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
            <!-- URL to add -->
            <arg type="s" name="url"/>
        </method>

        <!-- Delete some song from the playlist -->
        <method name="Delete">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
            <!-- Position of song to delete -->
            <arg type="i" name="pos"/>
        </method>

        <!-- Clear the playlist -->
        <method name="Clear">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

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

        <!-- Toggle repeat -->
        <method name="Repeat">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>

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

        <!-- Toggle shuffle -->
        <method name="Shuffle">
            <annotation name="org.freedesktop.DBus.GLib.NoReply" value=""/>
        </method>
    </interface>
</node>