Audacious  $Id:Doxyfile42802007-03-2104:39:00Znenolod$
audctrl.h
Go to the documentation of this file.
1 /*
2  * audctrl.h
3  * Copyright 2007-2011 Ben Tucker, William Pitcock, Yoshiki Yazawa,
4  * Matti Hämäläinen, and John Lindgren
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions, and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions, and the following disclaimer in the documentation
14  * provided with the distribution.
15  *
16  * This software is provided "as is" and without any warranty, express or
17  * implied. In no event shall the authors be liable for any damages arising from
18  * the use of this software.
19  */
20 
21 #ifndef AUDACIOUS_AUDCTRL_H
22 #define AUDACIOUS_AUDCTRL_H
23 
24 #include <glib.h>
25 #include <dbus/dbus-glib.h>
26 
27 G_BEGIN_DECLS
28 
29 void audacious_remote_playlist(DBusGProxy *proxy, gchar **list, gint num,
30  gboolean enqueue);
31 gchar *audacious_remote_get_version(DBusGProxy *proxy);
32 void audacious_remote_playlist_add(DBusGProxy *proxy, GList *list);
33 void audacious_remote_playlist_delete(DBusGProxy *proxy, guint pos);
34 void audacious_remote_play(DBusGProxy *proxy);
35 void audacious_remote_pause(DBusGProxy *proxy);
36 void audacious_remote_stop(DBusGProxy *proxy);
37 gboolean audacious_remote_is_playing(DBusGProxy *proxy);
38 gboolean audacious_remote_is_paused(DBusGProxy *proxy);
39 gint audacious_remote_get_playlist_pos(DBusGProxy *proxy);
40 void audacious_remote_set_playlist_pos(DBusGProxy *proxy, guint pos);
41 gint audacious_remote_get_playlist_length(DBusGProxy *proxy);
42 void audacious_remote_playlist_clear(DBusGProxy *proxy);
43 gint audacious_remote_get_output_time(DBusGProxy *proxy);
44 void audacious_remote_jump_to_time(DBusGProxy *proxy, guint pos);
45 void audacious_remote_get_volume(DBusGProxy *proxy, gint *vl, gint *vr);
46 gint audacious_remote_get_main_volume(DBusGProxy *proxy);
47 gint audacious_remote_get_balance(DBusGProxy *proxy);
48 void audacious_remote_set_volume(DBusGProxy *proxy, gint vl, gint vr);
49 void audacious_remote_set_main_volume(DBusGProxy *proxy, gint v);
50 void audacious_remote_set_balance(DBusGProxy *proxy, gint b);
51 gchar *audacious_remote_get_skin(DBusGProxy *proxy);
52 void audacious_remote_set_skin(DBusGProxy *proxy, gchar *skinfile);
53 gchar *audacious_remote_get_playlist_file(DBusGProxy *proxy, guint pos);
54 gchar *audacious_remote_get_playlist_title(DBusGProxy *proxy, guint pos);
55 gint audacious_remote_get_playlist_time(DBusGProxy *proxy, guint pos);
56 void audacious_remote_get_info(DBusGProxy *proxy, gint *rate, gint *freq,
57  gint *nch);
58 void audacious_remote_main_win_toggle(DBusGProxy *proxy, gboolean show);
59 gboolean audacious_remote_is_main_win(DBusGProxy *proxy);
60 void audacious_remote_show_prefs_box(DBusGProxy *proxy);
61 void audacious_remote_toggle_aot(DBusGProxy *proxy, gboolean ontop);
62 void audacious_remote_eject(DBusGProxy *proxy);
63 void audacious_remote_playlist_prev(DBusGProxy *proxy);
64 void audacious_remote_playlist_next(DBusGProxy *proxy);
65 void audacious_remote_playlist_add_url_string(DBusGProxy *proxy,
66  gchar *string);
67 gboolean audacious_remote_is_running(DBusGProxy *proxy);
68 void audacious_remote_toggle_repeat(DBusGProxy *proxy);
69 void audacious_remote_toggle_shuffle(DBusGProxy *proxy);
70 void audacious_remote_toggle_stop_after (DBusGProxy * proxy);
71 gboolean audacious_remote_is_repeat(DBusGProxy *proxy);
72 gboolean audacious_remote_is_shuffle(DBusGProxy *proxy);
73 gboolean audacious_remote_is_stop_after (DBusGProxy * proxy);
74 
75 void audacious_remote_get_eq(DBusGProxy *proxy, gdouble *preamp,
76  GArray **bands);
77 gdouble audacious_remote_get_eq_preamp(DBusGProxy *proxy);
78 gdouble audacious_remote_get_eq_band(DBusGProxy *proxy, gint band);
79 void audacious_remote_set_eq(DBusGProxy *proxy, gdouble preamp,
80  GArray *bands);
81 void audacious_remote_set_eq_preamp(DBusGProxy *proxy, gdouble preamp);
82 void audacious_remote_set_eq_band(DBusGProxy *proxy, gint band,
83  gdouble value);
84 
85 /* Added in XMMS 1.2.1 */
86 void audacious_remote_quit(DBusGProxy *proxy);
87 
88 /* Added in XMMS 1.2.6 */
89 void audacious_remote_play_pause(DBusGProxy *proxy);
90 void audacious_remote_playlist_ins_url_string(DBusGProxy *proxy,
91  gchar *string, guint pos);
92 
93 /* Added in XMMS 1.2.11 */
94 void audacious_remote_playqueue_add(DBusGProxy *proxy, guint pos);
95 void audacious_remote_playqueue_remove(DBusGProxy *proxy, guint pos);
96 gint audacious_remote_get_playqueue_length(DBusGProxy *proxy);
97 void audacious_remote_toggle_advance(DBusGProxy *proxy);
98 gboolean audacious_remote_is_advance(DBusGProxy *proxy);
99 
100 /* Added in Audacious 1.1 */
101 void audacious_remote_show_jtf_box(DBusGProxy *proxy);
102 void audacious_remote_playqueue_clear(DBusGProxy *proxy);
103 gboolean audacious_remote_playqueue_is_queued(DBusGProxy *proxy, guint pos);
104 gint audacious_remote_get_playqueue_list_position(DBusGProxy *proxy, guint qpos);
105 gint audacious_remote_get_playqueue_queue_position(DBusGProxy *proxy, guint pos);
106 
107 /* Added in Audacious 1.2 */
108 void audacious_set_session_uri(DBusGProxy *proxy, gchar *uri);
109 gchar *audacious_get_session_uri(DBusGProxy *proxy);
110 void audacious_set_session_type(DBusGProxy *proxy, gint type);
111 
112 /* Added in Audacious 1.3 */
113 void audacious_remote_playlist_enqueue_to_temp(DBusGProxy *proxy,
114  gchar *string);
115 gchar *audacious_get_tuple_field_data(DBusGProxy *proxy, gchar *field,
116  guint pos);
117 /* Added in Audacious 1.4 */
118 void audacious_remote_show_about_box(DBusGProxy *proxy);
119 void audacious_remote_toggle_about_box(DBusGProxy *proxy, gboolean show);
120 void audacious_remote_toggle_jtf_box(DBusGProxy *proxy, gboolean show);
121 void audacious_remote_toggle_prefs_box(DBusGProxy *proxy, gboolean show);
122 void audacious_remote_toggle_filebrowser(DBusGProxy *proxy, gboolean show);
123 void audacious_remote_eq_activate(DBusGProxy *proxy, gboolean active);
124 
125 /* Added in Audacious 1.9 */
126 gchar **audacious_remote_get_tuple_fields(DBusGProxy *proxy);
127 
128 /* Added in Audacious 2.3 */
129 void audacious_remote_playlist_open_list (DBusGProxy * proxy, GList * list);
130 void audacious_remote_playlist_open_list_to_temp (DBusGProxy * proxy, GList *
131  list);
132 
133 /* Added in Audacious 2.4 */
134 gchar *audacious_remote_playlist_get_active_name(DBusGProxy *proxy);
135 
136 G_END_DECLS
137 
138 #endif /* AUDACIOUS_AUDCTRL_H */
EXPORT void audacious_remote_eq_activate(DBusGProxy *proxy, gboolean active)
Toggles the equalizer.
Definition: audctrl.c:966
EXPORT void audacious_remote_stop(DBusGProxy *proxy)
Tells audacious to stop.
Definition: audctrl.c:178
EXPORT void audacious_remote_playlist_next(DBusGProxy *proxy)
Tells audacious to move forward in the playlist.
Definition: audctrl.c:549
EXPORT gboolean audacious_remote_is_advance(DBusGProxy *proxy)
audacious_remote_is_advance:
Definition: audctrl.c:809
EXPORT void audacious_remote_show_about_box(DBusGProxy *proxy)
Tells audacious to show the about box.
Definition: audctrl.c:497
EXPORT void audacious_remote_playlist_delete(DBusGProxy *proxy, guint pos)
Deletes a playlist entry from current playlist in given position.
Definition: audctrl.c:148
EXPORT void audacious_remote_playlist_open_list(DBusGProxy *proxy, GList *list)
Sends a list of URIs for Audacious to open.
Definition: audctrl.c:106
EXPORT gchar * audacious_remote_get_playlist_file(DBusGProxy *proxy, guint pos)
Queries Audacious about a playlist entry&#39;s file.
Definition: audctrl.c:399
EXPORT void audacious_remote_playlist_open_list_to_temp(DBusGProxy *proxy, GList *list)
Sends a list of URIs for Audacious to open in a temporary playlist.
Definition: audctrl.c:127
EXPORT void audacious_remote_playlist_add(DBusGProxy *proxy, GList *list)
Sends a list of URIs to Audacious to add to the playlist.
Definition: audctrl.c:86
EXPORT void audacious_remote_show_prefs_box(DBusGProxy *proxy)
Tells audacious to show the preferences pane.
Definition: audctrl.c:477
void audacious_remote_set_skin(DBusGProxy *proxy, gchar *skinfile)
EXPORT gchar * audacious_remote_get_playlist_title(DBusGProxy *proxy, guint pos)
Queries Audacious about a playlist entry&#39;s title.
Definition: audctrl.c:413
EXPORT gboolean audacious_remote_is_running(DBusGProxy *proxy)
Check if an Audacious instance is running.
Definition: audctrl.c:572
EXPORT void audacious_remote_set_eq(DBusGProxy *proxy, gdouble preamp, GArray *bands)
Tells audacious to set the equalizer up using the provided values.
Definition: audctrl.c:694
bool_t enqueue
Definition: main.c:59
EXPORT void audacious_remote_playlist_enqueue_to_temp(DBusGProxy *proxy, gchar *string)
Tells audacious to add an URI to a temporary playlist.
Definition: audctrl.c:907
EXPORT void audacious_remote_set_eq_band(DBusGProxy *proxy, gint band, gdouble value)
Tells audacious to set an equalizer band&#39;s setting.
Definition: audctrl.c:717
EXPORT gint audacious_remote_get_playlist_pos(DBusGProxy *proxy)
audacious_remote_get_playlist_pos:
Definition: audctrl.c:219
EXPORT void audacious_remote_playlist_clear(DBusGProxy *proxy)
audacious_remote_playlist_clear:
Definition: audctrl.c:259
gchar * audacious_remote_get_skin(DBusGProxy *proxy)
EXPORT void audacious_remote_playqueue_remove(DBusGProxy *proxy, guint pos)
Tells audacious to remove a playlist entry from the playqueue.
Definition: audctrl.c:771
void audacious_set_session_type(DBusGProxy *proxy, gint type)
static float b[EQ_BANDS][2]
Definition: equalizer.c:56
EXPORT void audacious_remote_quit(DBusGProxy *proxy)
Requests audacious to quit.
Definition: audctrl.c:727
EXPORT gint audacious_remote_get_balance(DBusGProxy *proxy)
Queries audacious about the current balance.
Definition: audctrl.c:323
type
Definition: plugins-api.h:41
EXPORT void audacious_remote_playlist(DBusGProxy *proxy, gchar **list, gint num, gboolean enqueue)
Sends a list of URIs to Audacious, either replacing current playlist or enqueuing them...
Definition: audctrl.c:41
EXPORT gint audacious_remote_get_playlist_length(DBusGProxy *proxy)
audacious_remote_get_playlist_length:
Definition: audctrl.c:246
EXPORT gchar * audacious_remote_playlist_get_active_name(DBusGProxy *proxy)
Returns the active playlist name.
Definition: audctrl.c:987
EXPORT gint audacious_remote_get_playqueue_queue_position(DBusGProxy *proxy, guint pos)
Queries audacious about what the playqueue position is for a playlist entry.
Definition: audctrl.c:879
EXPORT gboolean audacious_remote_is_paused(DBusGProxy *proxy)
audacious_remote_is_paused:
Definition: audctrl.c:204
EXPORT void audacious_remote_set_balance(DBusGProxy *proxy, gint b)
Sets the balance in Audacious.
Definition: audctrl.c:371
EXPORT gchar * audacious_get_tuple_field_data(DBusGProxy *proxy, gchar *field, guint pos)
Queries Audacious about a playlist entry&#39;s tuple information.
Definition: audctrl.c:921
EXPORT void audacious_remote_playlist_add_url_string(DBusGProxy *proxy, gchar *string)
Tells audacious to add an URI to the playlist.
Definition: audctrl.c:560
EXPORT gint audacious_remote_get_playlist_time(DBusGProxy *proxy, guint pos)
Queries Audacious about a playlist entry&#39;s length.
Definition: audctrl.c:427
EXPORT void audacious_remote_main_win_toggle(DBusGProxy *proxy, gboolean show)
Toggles the main window&#39;s visibility.
Definition: audctrl.c:454
EXPORT void audacious_remote_get_volume(DBusGProxy *proxy, gint *vl, gint *vr)
Queries audacious for the current volume settings.
Definition: audctrl.c:298
EXPORT gboolean audacious_remote_is_playing(DBusGProxy *proxy)
Queries audacious about whether it is playing or not.
Definition: audctrl.c:189
gchar * audacious_get_session_uri(DBusGProxy *proxy)
EXPORT void audacious_remote_eject(DBusGProxy *proxy)
Tells audacious to display the open files pane.
Definition: audctrl.c:528
EXPORT gint audacious_remote_get_output_time(DBusGProxy *proxy)
audacious_remote_get_output_time:
Definition: audctrl.c:272
EXPORT gboolean audacious_remote_is_repeat(DBusGProxy *proxy)
Queries audacious about whether or not the repeat feature is active.
Definition: audctrl.c:616
EXPORT void audacious_remote_toggle_stop_after(DBusGProxy *proxy)
Definition: audctrl.c:604
EXPORT void audacious_remote_set_playlist_pos(DBusGProxy *proxy, guint pos)
audacious_remote_set_playlist_pos:
Definition: audctrl.c:233
EXPORT void audacious_remote_toggle_repeat(DBusGProxy *proxy)
Tells audacious to toggle the repeat feature.
Definition: audctrl.c:589
EXPORT void audacious_remote_play(DBusGProxy *proxy)
Requests audacious to begin playback.
Definition: audctrl.c:158
void audacious_set_session_uri(DBusGProxy *proxy, gchar *uri)
static bool_t active
Definition: equalizer.c:53
EXPORT void audacious_remote_toggle_aot(DBusGProxy *proxy, gboolean ontop)
Tells audacious to set the always-on-top feature.
Definition: audctrl.c:518
EXPORT gint audacious_remote_get_playqueue_length(DBusGProxy *proxy)
Queries audacious about the playqueue&#39;s length.
Definition: audctrl.c:784
EXPORT void audacious_remote_pause(DBusGProxy *proxy)
Tells audacious to pause.
Definition: audctrl.c:168
EXPORT gint audacious_remote_get_playqueue_list_position(DBusGProxy *proxy, guint qpos)
Queries audacious what is the playlist position for given a playqueue entry index.
Definition: audctrl.c:894
EXPORT gboolean audacious_remote_is_stop_after(DBusGProxy *proxy)
Definition: audctrl.c:636
EXPORT gdouble audacious_remote_get_eq_preamp(DBusGProxy *proxy)
Queries audacious about the equalizer preamp&#39;s setting.
Definition: audctrl.c:662
EXPORT void audacious_remote_playlist_prev(DBusGProxy *proxy)
audacious_remote_playlist_prev:
Definition: audctrl.c:539
EXPORT gchar ** audacious_remote_get_tuple_fields(DBusGProxy *proxy)
Returns a array of strings with available tuple field names.
Definition: audctrl.c:977
EXPORT void audacious_remote_get_eq(DBusGProxy *proxy, gdouble *preamp, GArray **bands)
Queries audacious about the equalizer settings.
Definition: audctrl.c:651
static int rate
Definition: equalizer.c:54
EXPORT gdouble audacious_remote_get_eq_band(DBusGProxy *proxy, gint band)
Queries audacious about an equalizer band&#39;s value.
Definition: audctrl.c:678
EXPORT gboolean audacious_remote_is_main_win(DBusGProxy *proxy)
Queries Audacious about the main window&#39;s visibility.
Definition: audctrl.c:465
EXPORT void audacious_remote_toggle_about_box(DBusGProxy *proxy, gboolean show)
Tells audacious to show/hide the about box.
Definition: audctrl.c:507
EXPORT gboolean audacious_remote_playqueue_is_queued(DBusGProxy *proxy, guint pos)
Queries audacious about whether or not a playlist entry is in the playqueue.
Definition: audctrl.c:865
EXPORT gint audacious_remote_get_main_volume(DBusGProxy *proxy)
Queries audacious about the current volume.
Definition: audctrl.c:309
EXPORT void audacious_remote_playqueue_clear(DBusGProxy *proxy)
audacious_remote_playqueue_clear:
Definition: audctrl.c:853
EXPORT gboolean audacious_remote_is_shuffle(DBusGProxy *proxy)
Queries audacious about whether or not the shuffle feature is active.
Definition: audctrl.c:629
EXPORT void audacious_remote_set_eq_preamp(DBusGProxy *proxy, gdouble preamp)
Tells audacious to set the equalizer&#39;s preamp setting.
Definition: audctrl.c:705
EXPORT void audacious_remote_toggle_prefs_box(DBusGProxy *proxy, gboolean show)
Tells audacious to show/hide the preferences pane.
Definition: audctrl.c:487
EXPORT void audacious_remote_toggle_advance(DBusGProxy *proxy)
Tells audacious to toggle the no-playlist-advance feature.
Definition: audctrl.c:796
EXPORT void audacious_remote_toggle_shuffle(DBusGProxy *proxy)
Tells audacious to toggle the shuffle feature.
Definition: audctrl.c:599
EXPORT void audacious_remote_set_main_volume(DBusGProxy *proxy, gint v)
Sets the volume in Audacious.
Definition: audctrl.c:349
EXPORT void audacious_remote_set_volume(DBusGProxy *proxy, gint vl, gint vr)
Sets the volume for the left and right channels in Audacious.
Definition: audctrl.c:337
EXPORT void audacious_remote_jump_to_time(DBusGProxy *proxy, guint pos)
audacious_remote_jump_to_time:
Definition: audctrl.c:286
EXPORT void audacious_remote_toggle_filebrowser(DBusGProxy *proxy, gboolean show)
Tells audacious to show the filebrowser dialog.
Definition: audctrl.c:842
EXPORT void audacious_remote_playqueue_add(DBusGProxy *proxy, guint pos)
Tells audacious to add a playlist entry to the playqueue.
Definition: audctrl.c:760
EXPORT gchar * audacious_remote_get_version(DBusGProxy *proxy)
Queries Audacious for its version identifier.
Definition: audctrl.c:72
EXPORT void audacious_remote_toggle_jtf_box(DBusGProxy *proxy, gboolean show)
Tells audacious to show/hide the Jump-to-File pane.
Definition: audctrl.c:831
EXPORT void audacious_remote_play_pause(DBusGProxy *proxy)
Tells audacious to toggle between play and pause.
Definition: audctrl.c:737
EXPORT void audacious_remote_get_info(DBusGProxy *proxy, gint *rate, gint *freq, gint *nch)
Queries Audacious about the current audio format.
Definition: audctrl.c:442
EXPORT void audacious_remote_show_jtf_box(DBusGProxy *proxy)
Tells audacious to show the Jump-to-File pane.
Definition: audctrl.c:821
EXPORT void audacious_remote_playlist_ins_url_string(DBusGProxy *proxy, gchar *string, guint pos)
Tells audacious to add an URI to the playlist at a specific position.
Definition: audctrl.c:748