![]() |
![]() |
![]() |
libaudacious SDK Reference Manual | ![]() |
---|---|---|---|---|
Control Socket API ("beepctrl")Control Socket API ("beepctrl") — Remote access to an Audacious server. |
gint xmms_connect_to_session (gint session);void xmms_remote_playlist (gint session,gchar **list,gint num,gboolean enqueue);gint xmms_remote_get_version (gint session);void xmms_remote_playlist_add (gint session,GList *list);void xmms_remote_playlist_delete (gint session,gint pos);void xmms_remote_play (gint session);void xmms_remote_pause (gint session);void xmms_remote_stop (gint session);gboolean xmms_remote_is_playing (gint session);gboolean xmms_remote_is_paused (gint session);gint xmms_remote_get_playlist_pos (gint session);void xmms_remote_set_playlist_pos (gint session,gint pos);gint xmms_remote_get_playlist_length (gint session);void xmms_remote_playlist_clear (gint session);gint xmms_remote_get_output_time (gint session);void xmms_remote_jump_to_time (gint session,gint pos);void xmms_remote_get_volume (gint session,gint *vl,gint *vr);gint xmms_remote_get_main_volume (gint session);gint xmms_remote_get_balance (gint session);void xmms_remote_set_volume (gint session,gint vl,gint vr);void xmms_remote_set_main_volume (gint session,gint v);void xmms_remote_set_balance (gint session,gint b);gchar * xmms_remote_get_skin (gint session);void xmms_remote_set_skin (gint session,gchar *skinfile);gchar * xmms_remote_get_playlist_file (gint session,gint pos);gchar * xmms_remote_get_playlist_title (gint session,gint pos);gint xmms_remote_get_playlist_time (gint session,gint pos);void xmms_remote_get_info (gint session,gint *rate,gint *freq,gint *nch);void xmms_remote_main_win_toggle (gint session,gboolean show);void xmms_remote_pl_win_toggle (gint session,gboolean show);void xmms_remote_eq_win_toggle (gint session,gboolean show);gboolean xmms_remote_is_main_win (gint session);gboolean xmms_remote_is_pl_win (gint session);gboolean xmms_remote_is_eq_win (gint session);void xmms_remote_show_prefs_box (gint session);void xmms_remote_toggle_aot (gint session,gboolean ontop);void xmms_remote_eject (gint session);void xmms_remote_playlist_prev (gint session);void xmms_remote_playlist_next (gint session);void xmms_remote_playlist_add_url_string (gint session,gchar *string);gboolean xmms_remote_is_running (gint session);void xmms_remote_toggle_repeat (gint session);void xmms_remote_toggle_shuffle (gint session);gboolean xmms_remote_is_repeat (gint session);gboolean xmms_remote_is_shuffle (gint session);void xmms_remote_get_eq (gint session,gfloat *preamp,gfloat **bands);gfloat xmms_remote_get_eq_preamp (gint session);gfloat xmms_remote_get_eq_band (gint session,gint band);void xmms_remote_set_eq (gint session,gfloat preamp,gfloat *bands);void xmms_remote_set_eq_preamp (gint session,gfloat preamp);void xmms_remote_set_eq_band (gint session,gint band,gfloat value);void xmms_remote_quit (gint session);void xmms_remote_play_pause (gint session);void xmms_remote_playlist_ins_url_string (gint session,gchar *string,gint pos);void xmms_remote_playqueue_add (gint session,gint pos);void xmms_remote_playqueue_remove (gint session,gint pos);gint xmms_remote_get_playqueue_length (gint session);void xmms_remote_toggle_advance (gint session);gboolean xmms_remote_is_advance (gint session);void xmms_remote_activate (gint session);void xmms_remote_show_jtf_box (gint session);void xmms_remote_playqueue_clear (gint session);gboolean xmms_remote_playqueue_is_queued (gint session,gint pos);gint xmms_remote_get_playqueue_position (gint session,gint pos);gint xmms_remote_get_playqueue_queue_position (gint session,gint pos);void audacious_set_session_uri (gchar *uri);gchar * audacious_get_session_uri (gint session);void audacious_set_session_type (gint type);void xmms_remote_play_files (gint session,GList *list); #define xmms_remote_add_files (session,list)
gint xmms_connect_to_session (gint session);
Connects to an audacious server.
|
Legacy XMMS-style session identifier. |
Returns : |
an FD on success, otherwise -1. |
void xmms_remote_playlist (gint session,gchar **list,gint num,gboolean enqueue);
Sends a playlist to audacious.
|
Legacy XMMS-style session identifier. |
|
A list of URIs to play. |
|
Number of URIs to play. |
|
Whether or not the new playlist should be added on, or replace the current playlist. |
gint xmms_remote_get_version (gint session);
Queries audacious for it's protocol version.
|
Legacy XMMS-style session identifier. |
Returns : |
The protocol version used by Audacious. |
void xmms_remote_playlist_add (gint session,GList *list);
Sends a list of URIs to Audacious to add to the playlist.
|
Legacy XMMS-style session identifier. |
|
A GList of URIs to add to the playlist. |
void xmms_remote_playlist_delete (gint session,gint pos);
Deletes a playlist entry.
|
Legacy XMMS-style session identifier. |
|
The playlist position to delete. |
void xmms_remote_play (gint session);
Tells audacious to begin playback.
|
Legacy XMMS-style session identifier. |
void xmms_remote_pause (gint session);
Tells audacious to pause.
|
Legacy XMMS-style session identifier. |
void xmms_remote_stop (gint session);
Tells audacious to stop.
|
Legacy XMMS-style session identifier. |
gboolean xmms_remote_is_playing (gint session);
Queries audacious about whether it is playing or not.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if playing, FALSE otherwise. |
gboolean xmms_remote_is_paused (gint session);
Queries audacious about whether it is paused or not.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if playing, FALSE otherwise. |
gint xmms_remote_get_playlist_pos (gint session);
Queries audacious about the current playlist position.
|
Legacy XMMS-style session identifier. |
Returns : |
The current playlist position. |
void xmms_remote_set_playlist_pos (gint session,gint pos);
Tells audacious to jump to a different playlist position.
|
Legacy XMMS-style session identifier. |
|
Playlist position to jump to. |
gint xmms_remote_get_playlist_length (gint session);
Queries audacious about the current playlist length.
|
Legacy XMMS-style session identifier. |
Returns : |
The amount of entries in the playlist. |
void xmms_remote_playlist_clear (gint session);
Clears the playlist.
|
Legacy XMMS-style session identifier. |
gint xmms_remote_get_output_time (gint session);
Queries audacious about the current output position.
|
Legacy XMMS-style session identifier. |
Returns : |
The current output position. |
void xmms_remote_jump_to_time (gint session,gint pos);
Tells audacious to seek to a new time position.
|
Legacy XMMS-style session identifier. |
|
The time (in milliseconds) to jump to. |
void xmms_remote_get_volume (gint session,gint *vl,gint *vr);
Queries audacious about the current volume.
|
Legacy XMMS-style session identifier. |
|
Pointer to integer containing the left channel's volume. |
|
Pointer to integer containing the right channel's volume. |
gint xmms_remote_get_main_volume (gint session);
Queries audacious about the current volume.
|
Legacy XMMS-style session identifier. |
Returns : |
The current volume. |
gint xmms_remote_get_balance (gint session);
Queries audacious about the current balance.
|
Legacy XMMS-style session identifier. |
Returns : |
The current balance. |
void xmms_remote_set_volume (gint session,gint vl,gint vr);
Sets the volume for the left and right channels in Audacious.
|
Legacy XMMS-style session identifier. |
|
The volume for the left channel. |
|
The volume for the right channel. |
void xmms_remote_set_main_volume (gint session,gint v);
Sets the volume in Audacious.
|
Legacy XMMS-style session identifier. |
|
The volume to set. |
void xmms_remote_set_balance (gint session,gint b);
Sets the balance in Audacious.
|
Legacy XMMS-style session identifier. |
|
The balance to set. |
gchar * xmms_remote_get_skin (gint session);
Queries Audacious about it's skin.
|
Legacy XMMS-style session identifier. |
Returns : |
A path to the currently selected skin. |
void xmms_remote_set_skin (gint session,gchar *skinfile);
Tells audacious to start using the skinfile provided.
|
Legacy XMMS-style session identifier. |
|
Path to a skinfile to use with Audacious. |
gchar * xmms_remote_get_playlist_file (gint session,gint pos);
Queries Audacious about a playlist entry's file.
|
Legacy XMMS-style session identifier. |
|
The playlist position to query for. |
Returns : |
A path to the file in the playlist at pos |
gchar * xmms_remote_get_playlist_title (gint session,gint pos);
Queries Audacious about a playlist entry's title.
|
Legacy XMMS-style session identifier. |
|
The playlist position to query for. |
Returns : |
The title for the entry in the playlist at pos |
gint xmms_remote_get_playlist_time (gint session,gint pos);
Queries Audacious about a playlist entry's length.
|
Legacy XMMS-style session identifier. |
|
The playlist position to query for. |
Returns : |
The length of the entry in the playlist at pos |
void xmms_remote_get_info (gint session,gint *rate,gint *freq,gint *nch);
Queries Audacious about the current audio format.
|
Legacy XMMS-style session identifier. |
|
Pointer to an integer containing the bitrate. |
|
Pointer to an integer containing the frequency. |
|
Pointer to an integer containing the number of channels. |
void xmms_remote_main_win_toggle (gint session,gboolean show);
Toggles the main window's visibility.
|
Legacy XMMS-style session identifier. |
|
Whether or not to show the main window. |
void xmms_remote_pl_win_toggle (gint session,gboolean show);
Toggles the playlist window's visibility.
|
Legacy XMMS-style session identifier. |
|
Whether or not to show the playlist window. |
void xmms_remote_eq_win_toggle (gint session,gboolean show);
Toggles the equalizer window's visibility.
|
Legacy XMMS-style session identifier. |
|
Whether or not to show the equalizer window. |
gboolean xmms_remote_is_main_win (gint session);
Queries Audacious about the main window's visibility.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if visible, FALSE otherwise. |
gboolean xmms_remote_is_pl_win (gint session);
Queries Audacious about the playlist window's visibility.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if visible, FALSE otherwise. |
gboolean xmms_remote_is_eq_win (gint session);
Queries Audacious about the equalizer window's visibility.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if visible, FALSE otherwise. |
void xmms_remote_show_prefs_box (gint session);
Tells audacious to show the preferences pane.
|
Legacy XMMS-style session identifier. |
void xmms_remote_toggle_aot (gint session,gboolean ontop);
Tells audacious to toggle the always-on-top feature.
|
Legacy XMMS-style session identifier. |
|
Whether or not Audacious should be always-on-top. |
void xmms_remote_eject (gint session);
Tells audacious to display the open files pane.
|
Legacy XMMS-style session identifier. |
void xmms_remote_playlist_prev (gint session);
Tells audacious to move backwards in the playlist.
|
Legacy XMMS-style session identifier. |
void xmms_remote_playlist_next (gint session);
Tells audacious to move forward in the playlist.
|
Legacy XMMS-style session identifier. |
void xmms_remote_playlist_add_url_string (gint session,gchar *string);
Tells audacious to add an URI to the playlist.
|
Legacy XMMS-style session identifier. |
|
The URI to add. |
gboolean xmms_remote_is_running (gint session);
Checks to see if an Audacious server is running.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if yes, otherwise FALSE. |
void xmms_remote_toggle_repeat (gint session);
Tells audacious to toggle the repeat feature.
|
Legacy XMMS-style session identifier. |
void xmms_remote_toggle_shuffle (gint session);
Tells audacious to toggle the shuffle feature.
|
Legacy XMMS-style session identifier. |
gboolean xmms_remote_is_repeat (gint session);
Queries audacious about whether or not the repeat feature is active.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if yes, otherwise FALSE. |
gboolean xmms_remote_is_shuffle (gint session);
Queries audacious about whether or not the shuffle feature is active.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if yes, otherwise FALSE. |
void xmms_remote_get_eq (gint session,gfloat *preamp,gfloat **bands);
Queries audacious about the equalizer settings.
|
Legacy XMMS-style session identifier. |
|
Pointer to value for preamp setting. |
|
Pointer to array of band settings. |
gfloat xmms_remote_get_eq_preamp (gint session);
Queries audacious about the equalizer preamp's setting.
|
Legacy XMMS-style session identifier. |
Returns : |
The equalizer preamp's setting. |
gfloat xmms_remote_get_eq_band (gint session,gint band);
Queries audacious about an equalizer band's value.
|
Legacy XMMS-style session identifier. |
|
Which band to lookup the value for. |
Returns : |
The equalizer band's value. |
void xmms_remote_set_eq (gint session,gfloat preamp,gfloat *bands);
Tells audacious to set the equalizer up using the provided values.
|
Legacy XMMS-style session identifier. |
|
Value for preamp setting. |
|
Array of band settings. |
void xmms_remote_set_eq_preamp (gint session,gfloat preamp);
Tells audacious to set the equalizer's preamp setting.
|
Legacy XMMS-style session identifier. |
|
Value for preamp setting. |
void xmms_remote_set_eq_band (gint session,gint band,gfloat value);
Tells audacious to set an equalizer band's setting.
|
Legacy XMMS-style session identifier. |
|
The band to set the value for. |
|
The value to set that band to. |
void xmms_remote_quit (gint session);
Tells audacious to quit.
|
Legacy XMMS-style session identifier. |
void xmms_remote_play_pause (gint session);
Tells audacious to either play or pause.
|
Legacy XMMS-style session identifier. |
void xmms_remote_playlist_ins_url_string (gint session,gchar *string,gint pos);
Tells audacious to add an URI to the playlist at a specific position.
|
Legacy XMMS-style session identifier. |
|
The URI to add. |
|
The position to add the URI at. |
void xmms_remote_playqueue_add (gint session,gint pos);
Tells audacious to add a playlist entry to the playqueue.
|
Legacy XMMS-style session identifier. |
|
The playlist position to add to the queue. |
void xmms_remote_playqueue_remove (gint session,gint pos);
Tells audacious to remove a playlist entry from the playqueue.
|
Legacy XMMS-style session identifier. |
|
The playlist position to remove from the queue. |
gint xmms_remote_get_playqueue_length (gint session);
Queries audacious about the playqueue's length.
|
Legacy XMMS-style session identifier. |
Returns : |
The number of entries in the playqueue. |
void xmms_remote_toggle_advance (gint session);
Tells audacious to toggle the no-playlist-advance feature.
|
Legacy XMMS-style session identifier. |
gboolean xmms_remote_is_advance (gint session);
Queries audacious about whether or not the no-playlist-advance feature is active.
|
Legacy XMMS-style session identifier. |
Returns : |
TRUE if yes, otherwise FALSE. |
void xmms_remote_activate (gint session);
Tells audacious to display the main window and become the selected window.
|
Legacy XMMS-style session identifier. |
void xmms_remote_show_jtf_box (gint session);
Tells audacious to show the Jump-to-File pane.
|
Legacy XMMS-style session identifier. |
void xmms_remote_playqueue_clear (gint session);
Tells audacious to clear the playqueue.
|
Legacy XMMS-style session identifier. |
gboolean xmms_remote_playqueue_is_queued (gint session,gint pos);
Queries audacious about whether or not a playlist entry is in the playqueue.
|
Legacy XMMS-style session identifier. |
|
Position to check queue for. |
Returns : |
TRUE if yes, FALSE otherwise. |
gint xmms_remote_get_playqueue_position (gint session,gint pos);
Queries audacious about what the playqueue position is for a playlist entry.
|
Legacy XMMS-style session identifier. |
|
Position to check queue for. |
Returns : |
TRUE if yes, FALSE otherwise. |
gint xmms_remote_get_playqueue_queue_position (gint session,gint pos);
Queries audacious about what the playlist position is for a playqueue entry.
|
Legacy XMMS-style session identifier. |
|
Position to check queue for. |
Returns : |
TRUE if yes, FALSE otherwise. |
void audacious_set_session_uri (gchar *uri);
Sets the Session URI where Audacious can be reached at.
|
The session URI to set the client API to. |
gchar * audacious_get_session_uri (gint session);
Attempts to determine what the Session URI may be.
|
Legacy XMMS session id (usually 0). |
Returns : |
A session URI. |
void audacious_set_session_type (gint type);
Sets the type of session used by the audacious server.
|
The type to set the session type to. |
void xmms_remote_play_files (gint session,GList *list);
Sends a list of URIs to Audacious to play.
|
Legacy XMMS-style session identifier. |
|
A GList of URIs to play. |