mediamanager.h
Go to the documentation of this file.
1 
6 /* purple
7  *
8  * Purple is the legal property of its developers, whose names are too numerous
9  * to list here. Please refer to the COPYRIGHT file distributed with this
10  * source distribution.
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25  */
26 
27 #ifndef _PURPLE_MEDIA_MANAGER_H_
28 #define _PURPLE_MEDIA_MANAGER_H_
29 
30 #include <glib.h>
31 #include <glib-object.h>
32 
34 typedef struct _PurpleMediaManager PurpleMediaManager;
36 typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass;
37 
38 #include "account.h"
39 #include "media.h"
40 
41 G_BEGIN_DECLS
42 
43 #define PURPLE_TYPE_MEDIA_MANAGER (purple_media_manager_get_type())
44 #define PURPLE_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManager))
45 #define PURPLE_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
46 #define PURPLE_IS_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_MANAGER))
47 #define PURPLE_IS_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_MANAGER))
48 #define PURPLE_MEDIA_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /**************************************************************************/
56 /**************************************************************************/
67 
76 
91  PurpleAccount *account,
92  const char *conference_type,
93  const char *remote_user,
94  gboolean initiator);
95 
106 
118  PurpleMediaManager *manager, PurpleAccount *account);
119 
128 void
130  PurpleMedia *media);
131 
147  PurpleMediaManager *manager, PurpleMedia *media,
148  const gchar *session_id, const gchar *participant);
149 
164  PurpleMedia *media, const gchar *session_id,
165  const gchar *participant, gulong window_id);
166 
178  PurpleMediaManager *manager, gulong output_window_id);
179 
191  PurpleMediaManager *manager, PurpleMedia *media,
192  const gchar *session_id, const gchar *participant);
193 
203  PurpleMediaCaps caps);
204 
214 PurpleMediaCaps purple_media_manager_get_ui_caps(PurpleMediaManager *manager);
215 
225  GType backend_type);
226 
237 
238 /*}@*/
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 
244 G_END_DECLS
245 
246 #endif /* _PURPLE_MEDIA_MANAGER_H_ */
PurpleMediaManager * purple_media_manager_get(void)
Gets the "global" media manager object.
PurpleMediaCaps purple_media_manager_get_ui_caps(PurpleMediaManager *manager)
Gets which media caps the UI supports.
GType purple_media_manager_get_backend_type(PurpleMediaManager *manager)
Gets which media backend type media objects will use.
gboolean purple_media_manager_remove_output_window(PurpleMediaManager *manager, gulong output_window_id)
Remove a previously registerd output window.
Media API.
Structure representing an account.
Definition: account.h:126
void purple_media_manager_set_backend_type(PurpleMediaManager *manager, GType backend_type)
Sets which media backend type media objects will use.
struct _PurpleMediaManager PurpleMediaManager
An opaque structure representing a group of (usually all) media calls.
Definition: mediamanager.h:34
struct _PurpleMedia PurpleMedia
An opaque structure representing a media call.
Definition: media.h:47
Account API.
void purple_media_manager_remove_media(PurpleMediaManager *manager, PurpleMedia *media)
Removes a media session from the media manager.
GType purple_media_manager_get_type(void)
Gets the media manager's GType.
GList * purple_media_manager_get_media_by_account(PurpleMediaManager *manager, PurpleAccount *account)
Gets all of the media sessions for a given account.
void purple_media_manager_remove_output_windows(PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant)
Remove all output windows for a given conference/session/participant/stream.
gulong purple_media_manager_set_output_window(PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant, gulong window_id)
Registers a video output window to be created for a given stream.
PurpleMedia * purple_media_manager_create_media(PurpleMediaManager *manager, PurpleAccount *account, const char *conference_type, const char *remote_user, gboolean initiator)
Creates a media session.
GList * purple_media_manager_get_media(PurpleMediaManager *manager)
Gets all of the media sessions.
struct _PurpleMediaManagerClass PurpleMediaManagerClass
The GObject class structure of the PurpleMediaManager object.
Definition: mediamanager.h:36
void purple_media_manager_set_ui_caps(PurpleMediaManager *manager, PurpleMediaCaps caps)
Sets which media caps the UI supports.
gboolean purple_media_manager_create_output_window(PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant)
Signals that output windows should be created for the chosen stream.