1.1 --- a/Frameworks/libpurple.framework/Versions/0.6.0/Headers/mediamanager.h Fri Aug 21 13:24:36 2009 -0700
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,223 +0,0 @@
1.4 -/**
1.5 - * @file mediamanager.h Media Manager API
1.6 - * @ingroup core
1.7 - */
1.8 -
1.9 -/* purple
1.10 - *
1.11 - * Purple is the legal property of its developers, whose names are too numerous
1.12 - * to list here. Please refer to the COPYRIGHT file distributed with this
1.13 - * source distribution.
1.14 - *
1.15 - * This program is free software; you can redistribute it and/or modify
1.16 - * it under the terms of the GNU General Public License as published by
1.17 - * the Free Software Foundation; either version 2 of the License, or
1.18 - * (at your option) any later version.
1.19 - *
1.20 - * This program is distributed in the hope that it will be useful,
1.21 - * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.22 - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.23 - * GNU General Public License for more details.
1.24 - *
1.25 - * You should have received a copy of the GNU General Public License
1.26 - * along with this program; if not, write to the Free Software
1.27 - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1.28 - */
1.29 -
1.30 -#ifndef _PURPLE_MEDIA_MANAGER_H_
1.31 -#define _PURPLE_MEDIA_MANAGER_H_
1.32 -
1.33 -#include <glib.h>
1.34 -#include <glib-object.h>
1.35 -
1.36 -/** @copydoc _PurpleMediaManager */
1.37 -typedef struct _PurpleMediaManager PurpleMediaManager;
1.38 -/** @copydoc _PurpleMediaManagerClass */
1.39 -typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass;
1.40 -
1.41 -#include "account.h"
1.42 -#include "media.h"
1.43 -
1.44 -G_BEGIN_DECLS
1.45 -
1.46 -#define PURPLE_TYPE_MEDIA_MANAGER (purple_media_manager_get_type())
1.47 -#define PURPLE_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManager))
1.48 -#define PURPLE_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
1.49 -#define PURPLE_IS_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_MANAGER))
1.50 -#define PURPLE_IS_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_MANAGER))
1.51 -#define PURPLE_MEDIA_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass))
1.52 -
1.53 -#ifdef __cplusplus
1.54 -extern "C" {
1.55 -#endif
1.56 -
1.57 -/**************************************************************************/
1.58 -/** @name Media Manager API */
1.59 -/**************************************************************************/
1.60 -/*@{*/
1.61 -
1.62 -/**
1.63 - * Gets the media manager's GType.
1.64 - *
1.65 - * @return The media manager's GType.
1.66 - *
1.67 - * @since 2.6.0
1.68 - */
1.69 -GType purple_media_manager_get_type(void);
1.70 -
1.71 -/**
1.72 - * Gets the "global" media manager object. It's created if it doesn't already exist.
1.73 - *
1.74 - * @return The "global" instance of the media manager object.
1.75 - *
1.76 - * @since 2.6.0
1.77 - */
1.78 -PurpleMediaManager *purple_media_manager_get(void);
1.79 -
1.80 -/**
1.81 - * Creates a media session.
1.82 - *
1.83 - * @param manager The media manager to create the session under.
1.84 - * @param account The account to create the session on.
1.85 - * @param conference_type The conference type to feed into Farsight2.
1.86 - * @param remote_user The remote user to initiate the session with.
1.87 - *
1.88 - * @return A newly created media session.
1.89 - *
1.90 - * @since 2.6.0
1.91 - */
1.92 -PurpleMedia *purple_media_manager_create_media(PurpleMediaManager *manager,
1.93 - PurpleAccount *account,
1.94 - const char *conference_type,
1.95 - const char *remote_user,
1.96 - gboolean initiator);
1.97 -
1.98 -/**
1.99 - * Gets all of the media sessions.
1.100 - *
1.101 - * @param manager The media manager to get all of the sessions from.
1.102 - *
1.103 - * @return A list of all the media sessions.
1.104 - *
1.105 - * @since 2.6.0
1.106 - */
1.107 -GList *purple_media_manager_get_media(PurpleMediaManager *manager);
1.108 -
1.109 -/**
1.110 - * Gets all of the media sessions for a given account.
1.111 - *
1.112 - * @param manager The media manager to get the sessions from.
1.113 - * @param account The account the sessions are on.
1.114 - *
1.115 - * @return A list of the media sessions on the given account.
1.116 - *
1.117 - * @since 2.6.0
1.118 - */
1.119 -GList *purple_media_manager_get_media_by_account(
1.120 - PurpleMediaManager *manager, PurpleAccount *account);
1.121 -
1.122 -/**
1.123 - * Removes a media session from the media manager.
1.124 - *
1.125 - * @param manager The media manager to remove the media session from.
1.126 - * @param media The media session to remove.
1.127 - *
1.128 - * @since 2.6.0
1.129 - */
1.130 -void
1.131 -purple_media_manager_remove_media(PurpleMediaManager *manager,
1.132 - PurpleMedia *media);
1.133 -
1.134 -/**
1.135 - * Signals that output windows should be created for the chosen stream.
1.136 - *
1.137 - * This shouldn't be called outside of mediamanager.c and media.c
1.138 - *
1.139 - * @param manager Manager the output windows are registered with.
1.140 - * @param media Media session the output windows are registered for.
1.141 - * @param session_id The session the output windows are registered with.
1.142 - * @param participant The participant the output windows are registered with.
1.143 - *
1.144 - * @return TRUE if it succeeded, FALSE if it failed.
1.145 - *
1.146 - * @since 2.6.0
1.147 - */
1.148 -gboolean purple_media_manager_create_output_window(
1.149 - PurpleMediaManager *manager, PurpleMedia *media,
1.150 - const gchar *session_id, const gchar *participant);
1.151 -
1.152 -/**
1.153 - * Registers a video output window to be created for a given stream.
1.154 - *
1.155 - * @param manager The manager to register the output window with.
1.156 - * @param media The media instance to find the stream in.
1.157 - * @param session_id The session the stream is associated with.
1.158 - * @param participant The participant the stream is associated with.
1.159 - * @param window_id The window ID to embed the video in.
1.160 - *
1.161 - * @return A unique ID to the registered output window, 0 if it failed.
1.162 - *
1.163 - * @since 2.6.0
1.164 - */
1.165 -gulong purple_media_manager_set_output_window(PurpleMediaManager *manager,
1.166 - PurpleMedia *media, const gchar *session_id,
1.167 - const gchar *participant, gulong window_id);
1.168 -
1.169 -/**
1.170 - * Remove a previously registerd output window.
1.171 - *
1.172 - * @param manager The manager the output window was registered with.
1.173 - * @param output_window_id The ID of the output window.
1.174 - *
1.175 - * @return TRUE if it found the output window and was successful, else FALSE.
1.176 - *
1.177 - * @since 2.6.0
1.178 - */
1.179 -gboolean purple_media_manager_remove_output_window(
1.180 - PurpleMediaManager *manager, gulong output_window_id);
1.181 -
1.182 -/**
1.183 - * Remove all output windows for a given conference/session/participant/stream.
1.184 - *
1.185 - * @param manager The manager the output windows were registered with.
1.186 - * @param media The media instance the output windows were registered for.
1.187 - * @param session_id The session the output windows were registered for.
1.188 - * @param participant The participant the output windows were registered for.
1.189 - *
1.190 - * @since 2.6.0
1.191 - */
1.192 -void purple_media_manager_remove_output_windows(
1.193 - PurpleMediaManager *manager, PurpleMedia *media,
1.194 - const gchar *session_id, const gchar *participant);
1.195 -
1.196 -/**
1.197 - * Sets which media caps the UI supports.
1.198 - *
1.199 - * @param manager The manager to set the caps on.
1.200 - * @param caps The caps to set.
1.201 - *
1.202 - * @since 2.6.0
1.203 - */
1.204 -void purple_media_manager_set_ui_caps(PurpleMediaManager *manager,
1.205 - PurpleMediaCaps caps);
1.206 -
1.207 -/**
1.208 - * Gets which media caps the UI supports.
1.209 - *
1.210 - * @param manager The manager to get caps from.
1.211 - *
1.212 - * @return caps The caps retrieved.
1.213 - *
1.214 - * @since 2.6.0
1.215 - */
1.216 -PurpleMediaCaps purple_media_manager_get_ui_caps(PurpleMediaManager *manager);
1.217 -
1.218 -/*}@*/
1.219 -
1.220 -#ifdef __cplusplus
1.221 -}
1.222 -#endif
1.223 -
1.224 -G_END_DECLS
1.225 -
1.226 -#endif /* _PURPLE_MEDIA_MANAGER_H_ */