annotate libpurple/media/codec.h @ 29635:9549d3f8f7c2

Document the remaining functions.
author maiku@pidgin.im
date Fri, 13 Nov 2009 21:46:01 +0000
parents e18c1d347e37
children a52831eada67
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
1 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
2 * @file codec.h Codec for Media API
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
3 * @ingroup core
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
4 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
5
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
6 /* purple
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
7 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
8 * Purple is the legal property of its developers, whose names are too numerous
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
9 * to list here. Please refer to the COPYRIGHT file distributed with this
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
10 * source distribution.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
11 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
12 * This program is free software; you can redistribute it and/or modify
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
13 * it under the terms of the GNU General Public License as published by
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
14 * the Free Software Foundation; either version 2 of the License, or
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
15 * (at your option) any later version.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
16 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
17 * This program is distributed in the hope that it will be useful,
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
20 * GNU General Public License for more details.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
21 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
22 * You should have received a copy of the GNU General Public License
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
23 * along with this program; if not, write to the Free Software
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
25 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
26
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
27 #ifndef _PURPLE_MEDIA_CODEC_H_
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
28 #define _PURPLE_MEDIA_CODEC_H_
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
29
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
30 #include "enum-types.h"
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
31
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
32 /** An opaque structure representing an audio or video codec. */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
33 typedef struct _PurpleMediaCodec PurpleMediaCodec;
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
34
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
35 #include "util.h"
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
36
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
37 #include <glib-object.h>
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
38
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
39 G_BEGIN_DECLS
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
40
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
41 #define PURPLE_TYPE_MEDIA_CODEC (purple_media_codec_get_type())
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
42 #define PURPLE_IS_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CODEC))
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
43 #define PURPLE_IS_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CODEC))
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
44 #define PURPLE_MEDIA_CODEC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
45 #define PURPLE_MEDIA_CODEC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
46 #define PURPLE_MEDIA_CODEC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CODEC, PurpleMediaCodec))
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
47
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
48
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
49 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
50 * Gets the type of the media codec structure.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
51 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
52 * @return The media codec's GType
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
53 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
54 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
55 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
56 GType purple_media_codec_get_type(void);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
57
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
58 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
59 * Creates a new PurpleMediaCodec instance.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
60 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
61 * @param id Codec identifier.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
62 * @param encoding_name Name of the media type this encodes.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
63 * @param media_type PurpleMediaSessionType of this codec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
64 * @param clock_rate The clock rate this codec encodes at, if applicable.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
65 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
66 * @return The newly created PurpleMediaCodec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
67 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
68 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
69 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
70 PurpleMediaCodec *purple_media_codec_new(int id, const char *encoding_name,
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
71 PurpleMediaSessionType media_type, guint clock_rate);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
72
29635
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
73 /**
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
74 * Gets the codec id.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
75 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
76 * @param The codec to get the id from.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
77 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
78 * @return The codec id.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
79 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
80 * @since 2.6.0
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
81 */
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
82 guint purple_media_codec_get_id(PurpleMediaCodec *codec);
29635
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
83
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
84 /**
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
85 * Gets the encoding name.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
86 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
87 * @param The codec to get the encoding name from.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
88 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
89 * @return The encoding name.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
90 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
91 * @since 2.6.0
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
92 */
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
93 gchar *purple_media_codec_get_encoding_name(PurpleMediaCodec *codec);
29635
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
94
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
95 /**
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
96 * Gets the clock rate.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
97 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
98 * @param The codec to get the clock rate from.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
99 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
100 * @return The clock rate.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
101 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
102 * @since 2.6.0
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
103 */
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
104 guint purple_media_codec_get_clock_rate(PurpleMediaCodec *codec);
29635
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
105
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
106 /**
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
107 * Gets the number of channels.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
108 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
109 * @param The codec to get the number of channels from.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
110 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
111 * @return The number of channels.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
112 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
113 * @since 2.6.0
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
114 */
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
115 guint purple_media_codec_get_channels(PurpleMediaCodec *codec);
29635
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
116
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
117 /**
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
118 * Gets a list of the optional parameters.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
119 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
120 * The list consists of PurpleKeyValuePair's.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
121 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
122 * @param The codec to get the optional parameters from.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
123 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
124 * @return The list of optional parameters.
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
125 *
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
126 * @since 2.6.0
9549d3f8f7c2 Document the remaining functions.
maiku@pidgin.im
parents: 29538
diff changeset
127 */
29538
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
128 GList *purple_media_codec_get_optional_parameters(PurpleMediaCodec *codec);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
129
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
130 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
131 * Adds an optional parameter to the codec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
132 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
133 * @param codec The codec to add the parameter to.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
134 * @param name The name of the parameter to add.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
135 * @param value The value of the parameter to add.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
136 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
137 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
138 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
139 void purple_media_codec_add_optional_parameter(PurpleMediaCodec *codec,
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
140 const gchar *name, const gchar *value);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
141
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
142 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
143 * Removes an optional parameter from the codec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
144 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
145 * @param codec The codec to remove the parameter from.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
146 * @param param A pointer to the parameter to remove.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
147 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
148 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
149 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
150 void purple_media_codec_remove_optional_parameter(PurpleMediaCodec *codec,
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
151 PurpleKeyValuePair *param);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
152
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
153 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
154 * Gets an optional parameter based on the values given.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
155 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
156 * @param codec The codec to find the parameter in.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
157 * @param name The name of the parameter to search for.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
158 * @param value The value to search for or NULL.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
159 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
160 * @return The value found or NULL.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
161 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
162 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
163 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
164 PurpleKeyValuePair *purple_media_codec_get_optional_parameter(
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
165 PurpleMediaCodec *codec, const gchar *name,
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
166 const gchar *value);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
167
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
168 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
169 * Copies a PurpleMediaCodec object.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
170 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
171 * @param codec The codec to copy.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
172 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
173 * @return The copy of the codec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
174 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
175 * @since 2.7.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
176 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
177 PurpleMediaCodec *purple_media_codec_copy(PurpleMediaCodec *codec);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
178
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
179 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
180 * Copies a GList of PurpleMediaCodec and its contents.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
181 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
182 * @param codecs The list of codecs to be copied.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
183 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
184 * @return The copy of the GList.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
185 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
186 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
187 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
188 GList *purple_media_codec_list_copy(GList *codecs);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
189
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
190 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
191 * Frees a GList of PurpleMediaCodec and its contents.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
192 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
193 * @param codecs The list of codecs to be freed.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
194 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
195 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
196 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
197 void purple_media_codec_list_free(GList *codecs);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
198
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
199 /**
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
200 * Creates a string representation of the codec.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
201 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
202 * @param codec The codec to create the string of.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
203 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
204 * @return The new string representation.
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
205 *
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
206 * @since 2.6.0
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
207 */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
208 gchar *purple_media_codec_to_string(const PurpleMediaCodec *codec);
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
209
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
210 G_END_DECLS
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
211
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
212 #endif /* _PURPLE_MEDIA_CODEC_H_ */
e18c1d347e37 Break PurpleMediaCodec out into its own file.
maiku@pidgin.im
parents:
diff changeset
213