/usr/include/libpurple/media/backend-iface.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | /**
* @file backend-iface.h Interface for media backends
* @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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _MEDIA_BACKEND_IFACE_H_
#define _MEDIA_BACKEND_IFACE_H_
#include "codec.h"
#include "enum-types.h"
#include <glib-object.h>
G_BEGIN_DECLS
#define PURPLE_TYPE_MEDIA_BACKEND (purple_media_backend_get_type())
#define PURPLE_IS_MEDIA_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_BACKEND))
#define PURPLE_MEDIA_BACKEND(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_BACKEND, PurpleMediaBackend))
#define PURPLE_MEDIA_BACKEND_GET_INTERFACE(inst)(G_TYPE_INSTANCE_GET_INTERFACE((inst), PURPLE_TYPE_MEDIA_BACKEND, PurpleMediaBackendIface))
/** A placeholder to represent any media backend */
typedef struct _PurpleMediaBackend PurpleMediaBackend;
/** A structure to derive media backends from. */
typedef struct _PurpleMediaBackendIface PurpleMediaBackendIface;
struct _PurpleMediaBackendIface
{
GTypeInterface parent_iface; /**< The parent iface class */
/** Implementable functions called with purple_media_backend_* */
gboolean (*add_stream) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *who,
PurpleMediaSessionType type, gboolean initiator,
const gchar *transmitter,
guint num_params, GParameter *params);
void (*add_remote_candidates) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
GList *remote_candidates);
gboolean (*codecs_ready) (PurpleMediaBackend *self,
const gchar *sess_id);
GList *(*get_codecs) (PurpleMediaBackend *self,
const gchar *sess_id);
GList *(*get_local_candidates) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant);
gboolean (*set_remote_codecs) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
GList *codecs);
gboolean (*set_send_codec) (PurpleMediaBackend *self,
const gchar *sess_id, PurpleMediaCodec *codec);
gboolean (*set_encryption_parameters) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *cipher,
const gchar *auth, const gchar *key, gsize key_len);
gboolean (*set_decryption_parameters) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
const gchar *cipher, const gchar *auth,
const gchar *key, gsize key_len);
void (*set_params) (PurpleMediaBackend *self,
guint num_params, GParameter *params);
const gchar **(*get_available_params) (void);
gboolean (*send_dtmf) (PurpleMediaBackend *self,
const gchar *sess_id, gchar dtmf, guint8 volume,
guint16 duration);
gboolean (*set_send_rtcp_mux) (PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant, gboolean send_rtcp_mux);
};
/**
* Gets the media backend's GType.
*
* @return The media backend's GType.
*
* @since 2.7.0
*/
GType purple_media_backend_get_type(void);
/**
* Creates and adds a stream to the media backend.
*
* @param self The backend to add the stream to.
* @param sess_id The session id of the stream to add.
* @param who The remote participant of the stream to add.
* @param type The media type and direction of the stream to add.
* @param initiator True if the local user initiated the stream.
* @param transmitter The string id of the tranmsitter to use.
* @param num_params The number of parameters in the param parameter.
* @param params The additional parameters to pass when creating the stream.
*
* @return True if the stream was successfully created, othewise False.
*
* @since 2.7.0
*/
gboolean purple_media_backend_add_stream(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *who,
PurpleMediaSessionType type, gboolean initiator,
const gchar *transmitter,
guint num_params, GParameter *params);
/**
* Add remote candidates to a stream.
*
* @param self The backend the stream is in.
* @param sess_id The session id associated with the stream.
* @param participant The participant associated with the stream.
* @param remote_candidates The list of remote candidates to add.
*
* @since 2.7.0
*/
void purple_media_backend_add_remote_candidates(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
GList *remote_candidates);
/**
* Get whether or not a session's codecs are ready.
*
* A codec is ready if all of the attributes and additional
* parameters have been collected.
*
* @param self The media backend the session is in.
* @param sess_id The session id of the session to check.
*
* @return True if the codecs are ready, otherwise False.
*
* @since 2.7.0
*/
gboolean purple_media_backend_codecs_ready(PurpleMediaBackend *self,
const gchar *sess_id);
/**
* Gets the codec intersection list for a session.
*
* The intersection list consists of all codecs that are compatible
* between the local and remote software.
*
* @param self The media backend the session is in.
* @param sess_id The session id of the session to use.
*
* @return The codec intersection list.
*
* @since 2.7.0
*/
GList *purple_media_backend_get_codecs(PurpleMediaBackend *self,
const gchar *sess_id);
/**
* Gets the list of local candidates for a stream.
*
* @param self The media backend the stream is in.
* @param sess_id The session id associated with the stream.
* @param particilant The participant associated with the stream.
*
* @return The list of local candidates.
*
* @since 2.7.0
*/
GList *purple_media_backend_get_local_candidates(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant);
/**
* Sets the remote codecs on a stream.
*
* @param self The media backend the stream is in.
* @param sess_id The session id the stream is associated with.
* @param participant The participant the stream is associated with.
* @param codecs The list of remote codecs to set.
*
* @return True if the remote codecs were set successfully, otherwise False.
*
* @since 2.7.0
*/
gboolean purple_media_backend_set_remote_codecs(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
GList *codecs);
/**
* Sets which codec format to send media content in for a session.
*
* @param self The media backend the session is in.
* @param sess_id The session id of the session to set the codec for.
* @param codec The codec to set.
*
* @return True if set successfully, otherwise False.
*
* @since 2.7.0
*/
gboolean purple_media_backend_set_send_codec(PurpleMediaBackend *self,
const gchar *sess_id, PurpleMediaCodec *codec);
/**
* Sets the encryption parameters of our media in the session.
*
* @param self The media backend the session is in.
* @param sess_id The session id of the session to set parameters of.
* @param cipher The cipher to use to encrypt our media in the session.
* @param auth The algorithm to use to compute authentication codes for our
* media frames.
* @param key The encryption key.
* @param key_len Byte length of the encryption key.
*
* @since 2.11.0
*/
gboolean purple_media_backend_set_encryption_parameters(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *cipher,
const gchar *auth, const gchar *key, gsize key_len);
/**
* Sets the decryption parameters for a session participant's media.
*
* @param self The media backend the session is in.
* @param sess_id The session id of the session to set parameters of.
* @param participant The participant of the session to set parameters of.
* @param cipher The cipher to use to decrypt media coming from this session's
* participant.
* @param auth The algorithm to use for authentication of the media coming
* from the session's participant.
* @param key The decryption key.
* @param key_len Byte length of the decryption key.
*
* @since 2.11.0
*/
gboolean purple_media_backend_set_decryption_parameters(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant,
const gchar *cipher, const gchar *auth,
const gchar *key, gsize key_len);
/**
* Sets various optional parameters of the media backend.
*
* @param self The media backend to set the parameters on.
* @param num_params The number of parameters to pass to backend
* @param params Array of @c GParameter to pass to backend
*
* @since 2.8.0
*/
void purple_media_backend_set_params(PurpleMediaBackend *self,
guint num_params, GParameter *params);
/**
* Gets the list of optional parameters supported by the media backend.
*
* The list should NOT be freed.
*
* @param self The media backend
*
* @return NULL-terminated array of names of supported parameters.
*
* @since 2.8.0
*/
const gchar **purple_media_backend_get_available_params(PurpleMediaBackend *self);
/**
* purple_media_backend_set_send_rtcp_mux:
* @self: The media backend the session is in.
* @sess_id: The session id of the session to set the rtcp-mux option to
* @participant: The participant the stream is associated with.
* @send_rtcp_mux: Whether or not to enable rtcp-mux
*
* Controls whether or not the RTCP should be muxed with the RTP
*
* Returns: True if set successfully, otherwise False.
*
* @since 2.11.0
*/
gboolean purple_media_backend_set_send_rtcp_mux(PurpleMediaBackend *self,
const gchar *sess_id, const gchar *participant, gboolean send_rtcp_mux);
G_END_DECLS
#endif /* _MEDIA_BACKEND_IFACE_H_ */
|