Mercurial > pidgin
view libpurple/mediamanager.h @ 26133:735cb2a137db
Make it compile when --enable-vv is "no"
author | Marcus Lundblad <ml@update.uu.se> |
---|---|
date | Wed, 04 Mar 2009 23:10:31 +0000 |
parents | 75a02ffb0139 |
children | 1ae3af12095a |
line wrap: on
line source
/** * @file mediamanager.h Media Manager API * @ingroup core */ /* purple * * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef __MEDIA_MANAGER_H_ #define __MEDIA_MANAGER_H_ #ifdef USE_VV #include <glib.h> #include <glib-object.h> #include "connection.h" #include "media.h" G_BEGIN_DECLS #define PURPLE_TYPE_MEDIA_MANAGER (purple_media_manager_get_type()) #define PURPLE_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManager)) #define PURPLE_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass)) #define PURPLE_IS_MEDIA_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_MANAGER)) #define PURPLE_IS_MEDIA_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_MANAGER)) #define PURPLE_MEDIA_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_MANAGER, PurpleMediaManagerClass)) /** @copydoc _PurpleMediaManager */ typedef struct _PurpleMediaManager PurpleMediaManager; /** @copydoc _PurpleMediaManagerClass */ typedef struct _PurpleMediaManagerClass PurpleMediaManagerClass; /** @copydoc _PurpleMediaManagerPrivate */ typedef struct _PurpleMediaManagerPrivate PurpleMediaManagerPrivate; /** @copydoc _PurpleMediaElementInfo */ typedef struct _PurpleMediaElementInfo PurpleMediaElementInfo; /** The media manager class. */ struct _PurpleMediaManagerClass { GObjectClass parent_class; /**< The parent class. */ }; /** The media manager's data. */ struct _PurpleMediaManager { GObject parent; /**< The parent of this manager. */ PurpleMediaManagerPrivate *priv; /**< Private data for the manager. */ }; typedef enum { PURPLE_MEDIA_ELEMENT_AUDIO = 1, /** supports audio */ PURPLE_MEDIA_ELEMENT_VIDEO = 1 << 1, /** supports video */ PURPLE_MEDIA_ELEMENT_AUDIO_VIDEO = PURPLE_MEDIA_ELEMENT_AUDIO | PURPLE_MEDIA_ELEMENT_VIDEO, /** supports audio and video */ PURPLE_MEDIA_ELEMENT_NO_SRCS = 0, /** has no src pads */ PURPLE_MEDIA_ELEMENT_ONE_SRC = 1 << 2, /** has one src pad */ PURPLE_MEDIA_ELEMENT_MULTI_SRC = 1 << 3, /** has multiple src pads */ PURPLE_MEDIA_ELEMENT_REQUEST_SRC = 1 << 4, /** src pads must be requested */ PURPLE_MEDIA_ELEMENT_NO_SINKS = 0, /** has no sink pads */ PURPLE_MEDIA_ELEMENT_ONE_SINK = 1 << 5, /** has one sink pad */ PURPLE_MEDIA_ELEMENT_MULTI_SINK = 1 << 6, /** has multiple sink pads */ PURPLE_MEDIA_ELEMENT_REQUEST_SINK = 1 << 7, /** sink pads must be requested */ PURPLE_MEDIA_ELEMENT_UNIQUE = 1 << 8, /** This element is unique and only one instance of it should be created at a time */ PURPLE_MEDIA_ELEMENT_SRC = 1 << 9, /** can be set as an active src */ PURPLE_MEDIA_ELEMENT_SINK = 1 << 10, /** can be set as an active sink */ } PurpleMediaElementType; struct _PurpleMediaElementInfo { const gchar *id; PurpleMediaElementType type; GstElement *(*create)(void); }; #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @cname Media Manager API */ /**************************************************************************/ /*@{*/ /** * Gets the media manager's GType. * * @return The media manager's GType. */ GType purple_media_manager_get_type(void); /** * Gets the "global" media manager object. It's created if it doesn't already exist. * * @return The "global" instance of the media manager object. */ PurpleMediaManager *purple_media_manager_get(void); /** * Gets the pipeline from the media manager. * * @param manager The media manager to get the pipeline from. * * @return The pipeline. */ GstElement * purple_media_manager_get_pipeline(PurpleMediaManager *manager); /** * Creates a media session. * * @param manager The media manager to create the session under. * @param gc The connection to create the session on. * @param conference_type The conference type to feed into Farsight2. * @param remote_user The remote user to initiate the session with. * * @return A newly created media session. */ PurpleMedia *purple_media_manager_create_media(PurpleMediaManager *manager, PurpleConnection *gc, const char *conference_type, const char *remote_user, gboolean initiator); /** * Gets all of the media sessions. * * @param manager The media manager to get all of the sessions from. * * @return A list of all the media sessions. */ GList *purple_media_manager_get_media(PurpleMediaManager *manager); /** * Gets all of the media sessions for a given connection. * * @param manager The media manager to get the sessions from. * @param pc The connection the sessions are on. * * @return A list of the media sessions on the given connection. */ GList *purple_media_manager_get_media_by_connection( PurpleMediaManager *manager, PurpleConnection *pc); /** * Removes a media session from the media manager. * * @param manager The media manager to remove the media session from. * @param media The media session to remove. */ void purple_media_manager_remove_media(PurpleMediaManager *manager, PurpleMedia *media); /** * Returns a GStreamer source or sink for audio or video. * * @param manager The media manager to use to obtain the source/sink. * @param type The type of source/sink to get. */ GstElement *purple_media_manager_get_element(PurpleMediaManager *manager, PurpleMediaSessionType type); PurpleMediaElementInfo *purple_media_manager_get_element_info( PurpleMediaManager *manager, const gchar *name); gboolean purple_media_manager_register_element(PurpleMediaManager *manager, PurpleMediaElementInfo *info); gboolean purple_media_manager_unregister_element(PurpleMediaManager *manager, const gchar *name); gboolean purple_media_manager_set_active_element(PurpleMediaManager *manager, PurpleMediaElementInfo *info); PurpleMediaElementInfo *purple_media_manager_get_active_element( PurpleMediaManager *manager, PurpleMediaElementType type); /** * This shouldn't be called outside of mediamanager.c and media.c */ gboolean purple_media_manager_create_output_window( PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant); gulong purple_media_manager_set_output_window(PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant, gulong window_id); gboolean purple_media_manager_remove_output_window( PurpleMediaManager *manager, gulong output_window_id); void purple_media_manager_remove_output_windows( PurpleMediaManager *manager, PurpleMedia *media, const gchar *session_id, const gchar *participant); /*}@*/ #ifdef __cplusplus } #endif G_END_DECLS #endif /* USE_VV */ #endif /* __MEDIA_MANAGER_H_ */