Mercurial > pidgin
diff libpurple/media.h @ 32819:2c6510167895 default tip
propagate from branch 'im.pidgin.pidgin.2.x.y' (head 3315c5dfbd0ad16511bdcf865e5b07c02d07df24)
to branch 'im.pidgin.pidgin' (head cbd1eda6bcbf0565ae7766396bb8f6f419cb6a9a)
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Sat, 02 Jun 2012 02:30:49 +0000 |
parents | 98520ee78f12 |
children |
line wrap: on
line diff
--- a/libpurple/media.h Sat Jun 02 02:30:13 2012 +0000 +++ b/libpurple/media.h Sat Jun 02 02:30:49 2012 +0000 @@ -27,15 +27,13 @@ #ifndef _PURPLE_MEDIA_H_ #define _PURPLE_MEDIA_H_ +#include <glib.h> +#include <glib-object.h> + #include "media/candidate.h" #include "media/codec.h" #include "media/enum-types.h" -#include <glib.h> -#include <glib-object.h> - -G_BEGIN_DECLS - #define PURPLE_TYPE_MEDIA (purple_media_get_type()) #define PURPLE_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA, PurpleMedia)) #define PURPLE_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA, PurpleMediaClass)) @@ -49,16 +47,12 @@ #include "signals.h" #include "util.h" -#ifdef __cplusplus -extern "C" { -#endif +G_BEGIN_DECLS /** * Gets the media class's GType * * @return The media class's GType. - * - * @since 2.6.0 */ GType purple_media_get_type(void); @@ -68,8 +62,6 @@ * @param media The media session from which to retrieve session IDs. * * @return GList of session IDs. The caller must free the list. - * - * @since 2.6.0 */ GList *purple_media_get_session_ids(PurpleMedia *media); @@ -79,8 +71,6 @@ * @param media The media session to retrieve the account from. * * @return The account retrieved. - * - * @since 2.6.0 */ PurpleAccount *purple_media_get_account(PurpleMedia *media); @@ -90,8 +80,6 @@ * @param media The media session to retrieve the prpl data from. * * @return The prpl data retrieved. - * - * @since 2.6.0 */ gpointer purple_media_get_prpl_data(PurpleMedia *media); @@ -100,8 +88,6 @@ * * @param media The media session to set the prpl data on. * @param prpl_data The data to set on the media session. - * - * @since 2.6.0 */ void purple_media_set_prpl_data(PurpleMedia *media, gpointer prpl_data); @@ -111,8 +97,6 @@ * @param media The media object to set the state on. * @param error The format of the error message to send in the signal. * @param ... The arguments to plug into the format. - * - * @since 2.6.0 */ void purple_media_error(PurpleMedia *media, const gchar *error, ...); @@ -122,8 +106,6 @@ * @param media The media object with which to end streams. * @param session_id The session to end streams on. * @param participant The participant to end streams with. - * - * @since 2.6.0 */ void purple_media_end(PurpleMedia *media, const gchar *session_id, const gchar *participant); @@ -136,8 +118,6 @@ * @param session_id The id of the session of the stream being signaled. * @param participant The participant of the stream being signaled. * @param local TRUE if the info originated locally, FALSE if on the remote end. - * - * @since 2.6.0 */ void purple_media_stream_info(PurpleMedia *media, PurpleMediaInfoType type, const gchar *session_id, const gchar *participant, @@ -158,8 +138,6 @@ * @param media The media object to set the parameters on. * @param num_params The number of parameters to pass * @param params Array of @c GParameter to pass - * - * @since 2.8.0 */ void purple_media_set_params(PurpleMedia *media, guint num_params, GParameter *params); @@ -172,8 +150,6 @@ * @param media The media object * * @return NULL-terminated array of names of supported parameters. - * - * @since 2.8.0 */ const gchar **purple_media_get_available_params(PurpleMedia *media); @@ -184,8 +160,6 @@ * @param param name of parameter * * @return @c TRUE if backend recognizes the parameter, @c FALSE otherwise. - * - * @since 2.8.0 */ gboolean purple_media_param_is_supported(PurpleMedia *media, const gchar *param); @@ -205,8 +179,6 @@ * @param params The parameters to pass to Farsight. * * @return @c TRUE The stream was added successfully, @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id, const gchar *who, PurpleMediaSessionType type, @@ -220,8 +192,6 @@ * @param sess_id The session id of the session to get the type from. * * @return The retreived session type. - * - * @since 2.6.0 */ PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id); @@ -231,8 +201,6 @@ * @param media The media object to get the manager instance from. * * @return The PurpleMediaManager instance retrieved. - * - * @since 2.6.0 */ struct _PurpleMediaManager *purple_media_get_manager(PurpleMedia *media); @@ -243,8 +211,6 @@ * @param sess_id The session id of the session to get the codecs from. * * @return The retreieved codecs. - * - * @since 2.6.0 */ GList *purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id); @@ -255,8 +221,6 @@ * @param sess_id The session id of the session find the stream in. * @param participant The name of the remote user to add the candidates for. * @param remote_candidates The remote candidates to add. - * - * @since 2.6.0 */ void purple_media_add_remote_candidates(PurpleMedia *media, const gchar *sess_id, @@ -269,8 +233,6 @@ * @param media The media object to find the session in. * @param sess_id The session id of the session to find the stream in. * @param participant The name of the remote user to get the candidates from. - * - * @since 2.6.0 */ GList *purple_media_get_local_candidates(PurpleMedia *media, const gchar *sess_id, @@ -285,8 +247,6 @@ * from. * * @return The active candidates retrieved. - * - * @since 2.8.0 */ GList *purple_media_get_active_local_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant); @@ -300,8 +260,6 @@ * from. * * @return The remote candidates retrieved. - * - * @since 2.8.0 */ GList *purple_media_get_active_remote_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant); @@ -315,8 +273,6 @@ * @param codecs The list of remote codecs to set. * * @return @c TRUE The codecs were set successfully, or @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_set_remote_codecs(PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *codecs); @@ -329,8 +285,6 @@ * @param participant The remote user to check for. * * @return @c TRUE All streams for the given session_id/participant combination have candidates prepared, @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_candidates_prepared(PurpleMedia *media, const gchar *session_id, const gchar *participant); @@ -343,8 +297,6 @@ * @param codec The codec to set the session to stream. * * @return @c TRUE The codec was successfully changed, or @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_set_send_codec(PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec); @@ -355,8 +307,6 @@ * @param sess_id The session id of the session to check. * * @return @c TRUE The codecs are ready, or @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_codecs_ready(PurpleMedia *media, const gchar *sess_id); @@ -368,8 +318,6 @@ * @param participant The participant of the stream to check. * * @return TRUE if the local user is the stream's initator, else FALSE. - * - * @since 2.6.0 */ gboolean purple_media_is_initiator(PurpleMedia *media, const gchar *sess_id, const gchar *participant); @@ -382,8 +330,6 @@ * @param participant The participant to check. * * @return @c TRUE The selected streams have been accepted, or @c FALSE otherwise. - * - * @since 2.6.0 */ gboolean purple_media_accepted(PurpleMedia *media, const gchar *sess_id, const gchar *participant); @@ -394,8 +340,6 @@ * @param media The media object the sessions are in. * @param session_id The session to select (if any). * @param level The level to set the volume to. - * - * @since 2.6.0 */ void purple_media_set_input_volume(PurpleMedia *media, const gchar *session_id, double level); @@ -406,8 +350,6 @@ * @param session_id The session to limit the streams to (if any). * @param participant The participant to limit the streams to (if any). * @param level The level to set the volume to. - * - * @since 2.6.0 */ void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id, const gchar *participant, double level); @@ -421,8 +363,6 @@ * @param window_id The window id use for embedding the video in. * * @return An id to reference the output window. - * - * @since 2.6.0 */ gulong purple_media_set_output_window(PurpleMedia *media, const gchar *session_id, const gchar *participant, @@ -432,15 +372,9 @@ * Removes all output windows from a given media session. * * @param media The instance to remove all output windows from. - * - * @since 2.6.0 */ void purple_media_remove_output_windows(PurpleMedia *media); -#ifdef __cplusplus -} -#endif - G_END_DECLS #endif /* _PURPLE_MEDIA_H_ */