mediamanager.h

Go to the documentation of this file.
00001 
00006 /* purple
00007  *
00008  * Purple is the legal property of its developers, whose names are too numerous
00009  * to list here.  Please refer to the COPYRIGHT file distributed with this
00010  * source distribution.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00025  */
00026 
00027 #ifndef _PURPLE_MEDIA_MANAGER_H_
00028 #define _PURPLE_MEDIA_MANAGER_H_
00029 
00030 #include <glib.h>
00031 #include <glib-object.h>
00032 
00034 typedef struct _PurpleMediaManager PurpleMediaManager;
00036 typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass;
00037 
00038 #include "account.h"
00039 #include "media.h"
00040 
00057 typedef struct {
00058     void      (*readable)    (PurpleMediaManager *manager, PurpleMedia *media,
00059         const gchar *session_id, const gchar *participant, gpointer user_data);
00060     void      (*writable)    (PurpleMediaManager *manager, PurpleMedia *media,
00061         const gchar *session_id, const gchar *participant, gboolean writable,
00062         gpointer user_data);
00063 } PurpleMediaAppDataCallbacks;
00064 
00065 G_BEGIN_DECLS
00066 
00067 #define PURPLE_TYPE_MEDIA_MANAGER            (purple_media_manager_get_type())
00068 #define PURPLE_MEDIA_MANAGER(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManager))
00069 #define PURPLE_MEDIA_MANAGER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
00070 #define PURPLE_IS_MEDIA_MANAGER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_MANAGER))
00071 #define PURPLE_IS_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_MANAGER))
00072 #define PURPLE_MEDIA_MANAGER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
00073 
00074 #ifdef __cplusplus
00075 extern "C" {
00076 #endif
00077 
00078 /**************************************************************************/
00080 /**************************************************************************/
00090 GType purple_media_manager_get_type(void);
00091 
00099 PurpleMediaManager *purple_media_manager_get(void);
00100 
00114 PurpleMedia *purple_media_manager_create_media(PurpleMediaManager *manager,
00115                         PurpleAccount *account,
00116                         const char *conference_type,
00117                         const char *remote_user,
00118                         gboolean initiator);
00119 
00129 GList *purple_media_manager_get_media(PurpleMediaManager *manager);
00130 
00141 GList *purple_media_manager_get_media_by_account(
00142         PurpleMediaManager *manager, PurpleAccount *account);
00143 
00152 void
00153 purple_media_manager_remove_media(PurpleMediaManager *manager,
00154                   PurpleMedia *media);
00155 
00175 PurpleMedia *purple_media_manager_create_private_media(
00176                                                 PurpleMediaManager *manager,
00177                         PurpleAccount *account,
00178                         const char *conference_type,
00179                         const char *remote_user,
00180                         gboolean initiator);
00181 
00191 GList *purple_media_manager_get_private_media(PurpleMediaManager *manager);
00192 
00203 GList *purple_media_manager_get_private_media_by_account(
00204         PurpleMediaManager *manager, PurpleAccount *account);
00205 
00220 gboolean purple_media_manager_create_output_window(
00221         PurpleMediaManager *manager, PurpleMedia *media,
00222         const gchar *session_id, const gchar *participant);
00223 
00237 gulong purple_media_manager_set_output_window(PurpleMediaManager *manager,
00238         PurpleMedia *media, const gchar *session_id,
00239         const gchar *participant, gulong window_id);
00240 
00251 gboolean purple_media_manager_remove_output_window(
00252         PurpleMediaManager *manager, gulong output_window_id);
00253 
00264 void purple_media_manager_remove_output_windows(
00265         PurpleMediaManager *manager, PurpleMedia *media,
00266         const gchar *session_id, const gchar *participant);
00267 
00276 void purple_media_manager_set_ui_caps(PurpleMediaManager *manager,
00277         PurpleMediaCaps caps);
00278 
00288 PurpleMediaCaps purple_media_manager_get_ui_caps(PurpleMediaManager *manager);
00289 
00298 void purple_media_manager_set_backend_type(PurpleMediaManager *manager,
00299         GType backend_type);
00300 
00310 GType purple_media_manager_get_backend_type(PurpleMediaManager *manager);
00311 
00325 void purple_media_manager_set_application_data_callbacks(
00326     PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id,
00327     const gchar *participant, PurpleMediaAppDataCallbacks *callbacks,
00328     gpointer user_data, GDestroyNotify notify);
00329 
00351 gint purple_media_manager_send_application_data (
00352     PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id,
00353     const gchar *participant, gpointer buffer, guint size, gboolean blocking);
00354 
00372 gint purple_media_manager_receive_application_data (
00373     PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id,
00374     const gchar *participant, gpointer buffer, guint max_size,
00375     gboolean blocking);
00376 
00377 /*}@*/
00378 
00379 #ifdef __cplusplus
00380 }
00381 #endif
00382 
00383 G_END_DECLS
00384 
00385 #endif  /* _PURPLE_MEDIA_MANAGER_H_ */