media.h
Go to the documentation of this file.
1 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25  */
26 
27 #ifndef _PURPLE_MEDIA_H_
28 #define _PURPLE_MEDIA_H_
29 
30 #include "media/candidate.h"
31 #include "media/codec.h"
32 #include "media/enum-types.h"
33 
34 #include <glib.h>
35 #include <glib-object.h>
36 
37 G_BEGIN_DECLS
38 
39 #define PURPLE_TYPE_MEDIA (purple_media_get_type())
40 #define PURPLE_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA, PurpleMedia))
41 #define PURPLE_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA, PurpleMediaClass))
42 #define PURPLE_IS_MEDIA(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA))
43 #define PURPLE_IS_MEDIA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA))
44 #define PURPLE_MEDIA_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA, PurpleMediaClass))
45 
47 typedef struct _PurpleMedia PurpleMedia;
48 
49 #include "signals.h"
50 #include "util.h"
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
63 GType purple_media_get_type(void);
64 
75 
86 
97 
106 void purple_media_set_prpl_data(PurpleMedia *media, gpointer prpl_data);
107 
117 void purple_media_error(PurpleMedia *media, const gchar *error, ...);
118 
128 void purple_media_end(PurpleMedia *media, const gchar *session_id,
129  const gchar *participant);
130 
142 void purple_media_stream_info(PurpleMedia *media, PurpleMediaInfoType type,
143  const gchar *session_id, const gchar *participant,
144  gboolean local);
145 
165  guint num_params, GParameter *params);
166 
178 const gchar **purple_media_get_available_params(PurpleMedia *media);
179 
190 gboolean purple_media_param_is_supported(PurpleMedia *media, const gchar *param);
191 
211 gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id,
212  const gchar *who, PurpleMediaSessionType type,
213  gboolean initiator, const gchar *transmitter,
214  guint num_params, GParameter *params);
215 
226 PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id);
227 
237 struct _PurpleMediaManager *purple_media_get_manager(PurpleMedia *media);
238 
249 GList *purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id);
250 
262  const gchar *sess_id,
263  const gchar *participant,
264  GList *remote_candidates);
265 
276  const gchar *sess_id,
277  const gchar *participant);
278 
292  const gchar *sess_id, const gchar *participant);
293 
307  const gchar *sess_id, const gchar *participant);
308 
321 gboolean purple_media_set_remote_codecs(PurpleMedia *media, const gchar *sess_id,
322  const gchar *participant, GList *codecs);
323 
336  const gchar *session_id, const gchar *participant);
337 
349 gboolean purple_media_set_send_codec(PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec);
350 
365  const gchar *sess_id, const gchar *cipher,
366  const gchar *auth, const gchar *key, gsize key_len);
367 
384  const gchar *sess_id, const gchar *participant,
385  const gchar *cipher, const gchar *auth,
386  const gchar *key, gsize key_len);
387 
398 gboolean purple_media_codecs_ready(PurpleMedia *media, const gchar *sess_id);
399 
411  const gchar *sess_id, const gchar *participant, gboolean send_rtcp_mux);
412 
424 gboolean purple_media_is_initiator(PurpleMedia *media,
425  const gchar *sess_id, const gchar *participant);
426 
438 gboolean purple_media_accepted(PurpleMedia *media, const gchar *sess_id,
439  const gchar *participant);
440 
450 void purple_media_set_input_volume(PurpleMedia *media, const gchar *session_id, double level);
451 
462 void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id,
463  const gchar *participant, double level);
464 
478  const gchar *session_id, const gchar *participant,
479  gulong window_id);
480 
489 
502 gboolean purple_media_send_dtmf(PurpleMedia *media, const gchar *session_id,
503  gchar dtmf, guint8 volume, guint16 duration);
504 
505 #ifdef __cplusplus
506 }
507 #endif
508 
509 G_END_DECLS
510 
511 #endif /* _PURPLE_MEDIA_H_ */
void purple_media_set_input_volume(PurpleMedia *media, const gchar *session_id, double level)
Sets the input volume of all the selected sessions.
void purple_media_end(PurpleMedia *media, const gchar *session_id, const gchar *participant)
Ends all streams that match the given parameters.
gboolean purple_media_set_encryption_parameters(PurpleMedia *media, const gchar *sess_id, const gchar *cipher, const gchar *auth, const gchar *key, gsize key_len)
Sets the encryption parameters of our media in the session.
gboolean purple_media_param_is_supported(PurpleMedia *media, const gchar *param)
Checks if given optional parameter is supported by the media backend.
gboolean purple_media_is_initiator(PurpleMedia *media, const gchar *sess_id, const gchar *participant)
Gets whether the local user is the conference/session/stream's initiator.
void purple_media_remove_output_windows(PurpleMedia *media)
Removes all output windows from a given media session.
gulong purple_media_set_output_window(PurpleMedia *media, const gchar *session_id, const gchar *participant, gulong window_id)
Sets a video output window for the given session/stream.
GList * purple_media_get_active_local_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant)
Gets the active local candidates for the stream.
void purple_media_error(PurpleMedia *media, const gchar *error,...)
Signals an error in the media session.
Structure representing an account.
Definition: account.h:126
GList * purple_media_get_active_remote_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant)
Gets the active remote candidates for the stream.
void purple_media_stream_info(PurpleMedia *media, PurpleMediaInfoType type, const gchar *session_id, const gchar *participant, gboolean local)
Signals different information about the given stream.
PurpleMediaSessionType purple_media_get_session_type(PurpleMedia *media, const gchar *sess_id)
Gets the session type from a session.
GType purple_media_get_type(void)
Gets the media class's GType.
gboolean purple_media_candidates_prepared(PurpleMedia *media, const gchar *session_id, const gchar *participant)
Returns whether or not the candidates for set of streams are prepared.
void purple_media_set_params(PurpleMedia *media, guint num_params, GParameter *params)
Sets various optional parameters of the media call.
gboolean purple_media_add_stream(PurpleMedia *media, const gchar *sess_id, const gchar *who, PurpleMediaSessionType type, gboolean initiator, const gchar *transmitter, guint num_params, GParameter *params)
Adds a stream to a session.
Utility Functions.
void purple_media_add_remote_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *remote_candidates)
Adds remote candidates to the stream.
gboolean purple_media_accepted(PurpleMedia *media, const gchar *sess_id, const gchar *participant)
Gets whether a streams selected have been accepted.
GList * purple_media_get_session_ids(PurpleMedia *media)
Gets a list of session IDs.
gboolean purple_media_set_send_codec(PurpleMedia *media, const gchar *sess_id, PurpleMediaCodec *codec)
Sets the send codec for the a session.
struct _PurpleMedia PurpleMedia
An opaque structure representing a media call.
Definition: media.h:47
const gchar ** purple_media_get_available_params(PurpleMedia *media)
Gets the list of optional parameters supported by the media backend.
GList * purple_media_get_local_candidates(PurpleMedia *media, const gchar *sess_id, const gchar *participant)
Gets the local candidates from a stream.
struct _PurpleMediaManager * purple_media_get_manager(PurpleMedia *media)
Gets the PurpleMediaManager this media session is a part of.
Signal API.
PurpleAccount * purple_media_get_account(PurpleMedia *media)
Gets the PurpleAccount this media session is on.
GList * purple_media_get_codecs(PurpleMedia *media, const gchar *sess_id)
Gets the codecs from a session.
gboolean purple_media_send_dtmf(PurpleMedia *media, const gchar *session_id, gchar dtmf, guint8 volume, guint16 duration)
Sends a DTMF signal out-of-band.
gboolean purple_media_set_decryption_parameters(PurpleMedia *media, const gchar *sess_id, const gchar *participant, const gchar *cipher, const gchar *auth, const gchar *key, gsize key_len)
Sets the decryption parameters for a session participant's media.
void purple_media_set_output_volume(PurpleMedia *media, const gchar *session_id, const gchar *participant, double level)
Sets the output volume of all the selected streams.
void purple_media_set_prpl_data(PurpleMedia *media, gpointer prpl_data)
Sets the prpl data on the media session.
gboolean purple_media_set_remote_codecs(PurpleMedia *media, const gchar *sess_id, const gchar *participant, GList *codecs)
Sets remote candidates from the stream.
gboolean purple_media_codecs_ready(PurpleMedia *media, const gchar *sess_id)
Gets whether a session's codecs are ready to be used.
gboolean purple_media_set_send_rtcp_mux(PurpleMedia *media, const gchar *sess_id, const gchar *participant, gboolean send_rtcp_mux)
Sets the rtcp-mux option for the stream.
gpointer purple_media_get_prpl_data(PurpleMedia *media)
Gets the prpl data from the media session.