annotate doc/libaudacious/tmpl/beepctrl.sgml @ 2248:f47524760158 trunk

[svn] - added in audtool mainwin-show, playlist-show and equalizer-show to toggle display of audacious windows

<!-- ##### SECTION Title ##### -->
Control Socket API ("beepctrl")

<!-- ##### SECTION Short_Description ##### -->
Remote access to an Audacious server.

<!-- ##### SECTION Long_Description ##### -->
<para>
The control socket is used to remotely control audacious.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### FUNCTION xmms_connect_to_session ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_playlist ##### -->
<para>

</para>

@session: 
@list: 
@num: 
@enqueue: 


<!-- ##### FUNCTION xmms_remote_get_version ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_playlist_add ##### -->
<para>

</para>

@session: 
@list: 


<!-- ##### FUNCTION xmms_remote_playlist_delete ##### -->
<para>

</para>

@session: 
@pos: 


<!-- ##### FUNCTION xmms_remote_play ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_pause ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_stop ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_is_playing ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_is_paused ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_playlist_pos ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_set_playlist_pos ##### -->
<para>

</para>

@session: 
@pos: 


<!-- ##### FUNCTION xmms_remote_get_playlist_length ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_playlist_clear ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_get_output_time ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_jump_to_time ##### -->
<para>

</para>

@session: 
@pos: 


<!-- ##### FUNCTION xmms_remote_get_volume ##### -->
<para>

</para>

@session: 
@vl: 
@vr: 


<!-- ##### FUNCTION xmms_remote_get_main_volume ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_balance ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_set_volume ##### -->
<para>

</para>

@session: 
@vl: 
@vr: 


<!-- ##### FUNCTION xmms_remote_set_main_volume ##### -->
<para>

</para>

@session: 
@v: 


<!-- ##### FUNCTION xmms_remote_set_balance ##### -->
<para>

</para>

@session: 
@b: 


<!-- ##### FUNCTION xmms_remote_get_skin ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_set_skin ##### -->
<para>

</para>

@session: 
@skinfile: 


<!-- ##### FUNCTION xmms_remote_get_playlist_file ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_playlist_title ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_playlist_time ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_info ##### -->
<para>

</para>

@session: 
@rate: 
@freq: 
@nch: 


<!-- ##### FUNCTION xmms_remote_main_win_toggle ##### -->
<para>

</para>

@session: 
@show: 


<!-- ##### FUNCTION xmms_remote_pl_win_toggle ##### -->
<para>

</para>

@session: 
@show: 


<!-- ##### FUNCTION xmms_remote_eq_win_toggle ##### -->
<para>

</para>

@session: 
@show: 


<!-- ##### FUNCTION xmms_remote_is_main_win ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_is_pl_win ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_is_eq_win ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_show_prefs_box ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_toggle_aot ##### -->
<para>

</para>

@session: 
@ontop: 


<!-- ##### FUNCTION xmms_remote_eject ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playlist_prev ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playlist_next ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playlist_add_url_string ##### -->
<para>

</para>

@session: 
@string: 


<!-- ##### FUNCTION xmms_remote_is_running ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_toggle_repeat ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_toggle_shuffle ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_is_repeat ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_is_shuffle ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_eq ##### -->
<para>

</para>

@session: 
@preamp: 
@bands: 


<!-- ##### FUNCTION xmms_remote_get_eq_preamp ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_eq_band ##### -->
<para>

</para>

@session: 
@band: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_set_eq ##### -->
<para>

</para>

@session: 
@preamp: 
@bands: 


<!-- ##### FUNCTION xmms_remote_set_eq_preamp ##### -->
<para>

</para>

@session: 
@preamp: 


<!-- ##### FUNCTION xmms_remote_set_eq_band ##### -->
<para>

</para>

@session: 
@band: 
@value: 


<!-- ##### FUNCTION xmms_remote_quit ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_play_pause ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playlist_ins_url_string ##### -->
<para>

</para>

@session: 
@string: 
@pos: 


<!-- ##### FUNCTION xmms_remote_playqueue_add ##### -->
<para>

</para>

@session: 
@pos: 


<!-- ##### FUNCTION xmms_remote_playqueue_remove ##### -->
<para>

</para>

@session: 
@pos: 


<!-- ##### FUNCTION xmms_remote_get_playqueue_length ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_toggle_advance ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_is_advance ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_activate ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_show_jtf_box ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playqueue_clear ##### -->
<para>

</para>

@session: 


<!-- ##### FUNCTION xmms_remote_playqueue_is_queued ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_playqueue_position ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION xmms_remote_get_playqueue_queue_position ##### -->
<para>

</para>

@session: 
@pos: 
@Returns: 


<!-- ##### FUNCTION audacious_set_session_uri ##### -->
<para>

</para>

@uri: 


<!-- ##### FUNCTION audacious_get_session_uri ##### -->
<para>

</para>

@session: 
@Returns: 


<!-- ##### FUNCTION audacious_set_session_type ##### -->
<para>

</para>

@type: 


<!-- ##### FUNCTION xmms_remote_play_files ##### -->
<para>

</para>

@session: 
@list: 


<!-- ##### MACRO xmms_remote_add_files ##### -->
<para>

</para>

@session: 
@list: