Mercurial > pidgin.yaz
comparison libpurple/mediamanager.h @ 26168:af42303654a5
propagate from branch 'im.pidgin.pidgin' (head 0bb02399ead9501a3e7951cfba2e8e8350fe917c)
to branch 'im.pidgin.pidgin.vv' (head a940363ef1efa4bf53c71cbb8201f36ed5795583)
author | Mike Ruprecht <maiku@soc.pidgin.im> |
---|---|
date | Thu, 05 Feb 2009 00:31:35 +0000 |
parents | 0e8814c437b2 |
children | 730e760ca39f |
comparison
equal
deleted
inserted
replaced
25056:b0c75121cf66 | 26168:af42303654a5 |
---|---|
1 /** | |
2 * @file mediamanager.h Media Manager API | |
3 * @ingroup core | |
4 */ | |
5 | |
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
25 */ | |
26 | |
27 #ifndef __MEDIA_MANAGER_H_ | |
28 #define __MEDIA_MANAGER_H_ | |
29 | |
30 #ifdef USE_VV | |
31 | |
32 #include <glib.h> | |
33 #include <glib-object.h> | |
34 | |
35 #include "connection.h" | |
36 #include "media.h" | |
37 | |
38 G_BEGIN_DECLS | |
39 | |
40 #define PURPLE_TYPE_MEDIA_MANAGER (purple_media_manager_get_type()) | |
41 #define PURPLE_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManager)) | |
42 #define PURPLE_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass)) | |
43 #define PURPLE_IS_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_MANAGER)) | |
44 #define PURPLE_IS_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_MANAGER)) | |
45 #define PURPLE_MEDIA_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass)) | |
46 | |
47 /** @copydoc _PurpleMediaManager */ | |
48 typedef struct _PurpleMediaManager PurpleMediaManager; | |
49 /** @copydoc _PurpleMediaManagerClass */ | |
50 typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass; | |
51 /** @copydoc _PurpleMediaManagerPrivate */ | |
52 typedef struct _PurpleMediaManagerPrivate PurpleMediaManagerPrivate; | |
53 /** @copydoc _PurpleMediaElementInfo */ | |
54 typedef struct _PurpleMediaElementInfo PurpleMediaElementInfo; | |
55 | |
56 /** The media manager class. */ | |
57 struct _PurpleMediaManagerClass | |
58 { | |
59 GObjectClass parent_class; /**< The parent class. */ | |
60 }; | |
61 | |
62 /** The media manager's data. */ | |
63 struct _PurpleMediaManager | |
64 { | |
65 GObject parent; /**< The parent of this manager. */ | |
66 PurpleMediaManagerPrivate *priv; /**< Private data for the manager. */ | |
67 }; | |
68 | |
69 typedef enum { | |
70 PURPLE_MEDIA_ELEMENT_AUDIO = 1, /** supports audio */ | |
71 PURPLE_MEDIA_ELEMENT_VIDEO = 1 << 1, /** supports video */ | |
72 PURPLE_MEDIA_ELEMENT_AUDIO_VIDEO = PURPLE_MEDIA_ELEMENT_AUDIO | |
73 | PURPLE_MEDIA_ELEMENT_VIDEO, /** supports audio and video */ | |
74 | |
75 PURPLE_MEDIA_ELEMENT_NO_SRCS = 0, /** has no src pads */ | |
76 PURPLE_MEDIA_ELEMENT_ONE_SRC = 1 << 2, /** has one src pad */ | |
77 PURPLE_MEDIA_ELEMENT_MULTI_SRC = 1 << 3, /** has multiple src pads */ | |
78 PURPLE_MEDIA_ELEMENT_REQUEST_SRC = 1 << 4, /** src pads must be requested */ | |
79 | |
80 PURPLE_MEDIA_ELEMENT_NO_SINKS = 0, /** has no sink pads */ | |
81 PURPLE_MEDIA_ELEMENT_ONE_SINK = 1 << 5, /** has one sink pad */ | |
82 PURPLE_MEDIA_ELEMENT_MULTI_SINK = 1 << 6, /** has multiple sink pads */ | |
83 PURPLE_MEDIA_ELEMENT_REQUEST_SINK = 1 << 7, /** sink pads must be requested */ | |
84 | |
85 PURPLE_MEDIA_ELEMENT_UNIQUE = 1 << 8, /** This element is unique and | |
86 only one instance of it should | |
87 be created at a time */ | |
88 | |
89 PURPLE_MEDIA_ELEMENT_SRC = 1 << 9, /** can be set as an active src */ | |
90 PURPLE_MEDIA_ELEMENT_SINK = 1 << 10, /** can be set as an active sink */ | |
91 } PurpleMediaElementType; | |
92 | |
93 struct _PurpleMediaElementInfo | |
94 { | |
95 const gchar *id; | |
96 PurpleMediaElementType type; | |
97 GstElement *(*create)(void); | |
98 }; | |
99 | |
100 #ifdef __cplusplus | |
101 extern "C" { | |
102 #endif | |
103 | |
104 /**************************************************************************/ | |
105 /** @cname Media Manager API */ | |
106 /**************************************************************************/ | |
107 /*@{*/ | |
108 | |
109 /** | |
110 * Gets the media manager's GType. | |
111 * | |
112 * @return The media manager's GType. | |
113 */ | |
114 GType purple_media_manager_get_type(void); | |
115 | |
116 /** | |
117 * Gets the "global" media manager object. It's created if it doesn't already exist. | |
118 * | |
119 * @return The "global" instance of the media manager object. | |
120 */ | |
121 PurpleMediaManager *purple_media_manager_get(void); | |
122 | |
123 /** | |
124 * Creates a media session. | |
125 * | |
126 * @param manager The media manager to create the session under. | |
127 * @param gc The connection to create the session on. | |
128 * @param conference_type The conference type to feed into Farsight2. | |
129 * @param remote_user The remote user to initiate the session with. | |
130 * | |
131 * @return A newly created media session. | |
132 */ | |
133 PurpleMedia *purple_media_manager_create_media(PurpleMediaManager *manager, | |
134 PurpleConnection *gc, | |
135 const char *conference_type, | |
136 const char *remote_user, | |
137 gboolean initiator); | |
138 | |
139 /** | |
140 * Gets all of the media sessions. | |
141 * | |
142 * @param manager The media manager to get all of the sessions from. | |
143 * | |
144 * @return A list of all the media sessions. | |
145 */ | |
146 GList *purple_media_manager_get_media(PurpleMediaManager *manager); | |
147 | |
148 /** | |
149 * Removes a media session from the media manager. | |
150 * | |
151 * @param manager The media manager to remove the media session from. | |
152 * @param media The media session to remove. | |
153 */ | |
154 void | |
155 purple_media_manager_remove_media(PurpleMediaManager *manager, | |
156 PurpleMedia *media); | |
157 | |
158 /** | |
159 * Returns a GStreamer source or sink for audio or video. | |
160 * | |
161 * @param manager The media manager to use to obtain the source/sink. | |
162 * @param type The type of source/sink to get. | |
163 */ | |
164 GstElement *purple_media_manager_get_element(PurpleMediaManager *manager, | |
165 PurpleMediaSessionType type); | |
166 | |
167 PurpleMediaElementInfo *purple_media_manager_get_element_info( | |
168 PurpleMediaManager *manager, const gchar *name); | |
169 gboolean purple_media_manager_register_element(PurpleMediaManager *manager, | |
170 PurpleMediaElementInfo *info); | |
171 gboolean purple_media_manager_unregister_element(PurpleMediaManager *manager, | |
172 const gchar *name); | |
173 gboolean purple_media_manager_set_active_element(PurpleMediaManager *manager, | |
174 PurpleMediaElementInfo *info); | |
175 PurpleMediaElementInfo *purple_media_manager_get_active_element( | |
176 PurpleMediaManager *manager, PurpleMediaElementType type); | |
177 /*}@*/ | |
178 | |
179 #ifdef __cplusplus | |
180 } | |
181 #endif | |
182 | |
183 G_END_DECLS | |
184 | |
185 #endif /* USE_VV */ | |
186 | |
187 | |
188 #endif /* __MEDIA_MANAGER_H_ */ |