Mercurial > pidgin
comparison libpurple/media/candidate.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 | 02a2e8183b1d |
children |
comparison
equal
deleted
inserted
replaced
32818:01ff09d4a463 | 32819:2c6510167895 |
---|---|
45 | 45 |
46 /** | 46 /** |
47 * Gets the type of the media candidate structure. | 47 * Gets the type of the media candidate structure. |
48 * | 48 * |
49 * @return The media canditate's GType | 49 * @return The media canditate's GType |
50 * | |
51 * @since 2.6.0 | |
52 */ | 50 */ |
53 GType purple_media_candidate_get_type(void); | 51 GType purple_media_candidate_get_type(void); |
54 | 52 |
55 /** | 53 /** |
56 * Creates a PurpleMediaCandidate instance. | 54 * Creates a PurpleMediaCandidate instance. |
61 * @param proto The protocol this component is for. | 59 * @param proto The protocol this component is for. |
62 * @param ip The IP address of this component. | 60 * @param ip The IP address of this component. |
63 * @param port The network port. | 61 * @param port The network port. |
64 * | 62 * |
65 * @return The newly created PurpleMediaCandidate instance. | 63 * @return The newly created PurpleMediaCandidate instance. |
66 * | |
67 * @since 2.6.0 | |
68 */ | 64 */ |
69 PurpleMediaCandidate *purple_media_candidate_new( | 65 PurpleMediaCandidate *purple_media_candidate_new( |
70 const gchar *foundation, guint component_id, | 66 const gchar *foundation, guint component_id, |
71 PurpleMediaCandidateType type, | 67 PurpleMediaCandidateType type, |
72 PurpleMediaNetworkProtocol proto, | 68 PurpleMediaNetworkProtocol proto, |
76 * Copies a PurpleMediaCandidate. | 72 * Copies a PurpleMediaCandidate. |
77 * | 73 * |
78 * @param candidate The candidate to copy. | 74 * @param candidate The candidate to copy. |
79 * | 75 * |
80 * @return The copy of the PurpleMediaCandidate. | 76 * @return The copy of the PurpleMediaCandidate. |
81 * | |
82 * @since 2.7.0 | |
83 */ | 77 */ |
84 PurpleMediaCandidate *purple_media_candidate_copy( | 78 PurpleMediaCandidate *purple_media_candidate_copy( |
85 PurpleMediaCandidate *candidate); | 79 PurpleMediaCandidate *candidate); |
86 | 80 |
87 /** | 81 /** |
88 * Copies a GList of PurpleMediaCandidate and its contents. | 82 * Copies a GList of PurpleMediaCandidate and its contents. |
89 * | 83 * |
90 * @param candidates The list of candidates to be copied. | 84 * @param candidates The list of candidates to be copied. |
91 * | 85 * |
92 * @return The copy of the GList. | 86 * @return The copy of the GList. |
93 * | |
94 * @since 2.6.0 | |
95 */ | 87 */ |
96 GList *purple_media_candidate_list_copy(GList *candidates); | 88 GList *purple_media_candidate_list_copy(GList *candidates); |
97 | 89 |
98 /** | 90 /** |
99 * Frees a GList of PurpleMediaCandidate and its contents. | 91 * Frees a GList of PurpleMediaCandidate and its contents. |
100 * | 92 * |
101 * @param candidates The list of candidates to be freed. | 93 * @param candidates The list of candidates to be freed. |
102 * | |
103 * @since 2.6.0 | |
104 */ | 94 */ |
105 void purple_media_candidate_list_free(GList *candidates); | 95 void purple_media_candidate_list_free(GList *candidates); |
106 | 96 |
107 /** | 97 /** |
108 * Gets the foundation (identifier) from the candidate. | 98 * Gets the foundation (identifier) from the candidate. |
109 * | 99 * |
110 * @param candidate The candidate to get the foundation from. | 100 * @param candidate The candidate to get the foundation from. |
111 * | 101 * |
112 * @return The foundation. | 102 * @return The foundation. |
113 * | |
114 * @since 2.6.0 | |
115 */ | 103 */ |
116 gchar *purple_media_candidate_get_foundation(PurpleMediaCandidate *candidate); | 104 gchar *purple_media_candidate_get_foundation(PurpleMediaCandidate *candidate); |
117 | 105 |
118 /** | 106 /** |
119 * Gets the component id (rtp or rtcp) | 107 * Gets the component id (rtp or rtcp) |
120 * | 108 * |
121 * @param candidate The candidate to get the compnent id from. | 109 * @param candidate The candidate to get the compnent id from. |
122 * | 110 * |
123 * @return The component id. | 111 * @return The component id. |
124 * | |
125 * @since 2.6.0 | |
126 */ | 112 */ |
127 guint purple_media_candidate_get_component_id(PurpleMediaCandidate *candidate); | 113 guint purple_media_candidate_get_component_id(PurpleMediaCandidate *candidate); |
128 | 114 |
129 /** | 115 /** |
130 * Gets the IP address. | 116 * Gets the IP address. |
131 * | 117 * |
132 * @param candidate The candidate to get the IP address from. | 118 * @param candidate The candidate to get the IP address from. |
133 * | 119 * |
134 * @return The IP address. | 120 * @return The IP address. |
135 * | |
136 * @since 2.6.0 | |
137 */ | 121 */ |
138 gchar *purple_media_candidate_get_ip(PurpleMediaCandidate *candidate); | 122 gchar *purple_media_candidate_get_ip(PurpleMediaCandidate *candidate); |
139 | 123 |
140 /** | 124 /** |
141 * Gets the port. | 125 * Gets the port. |
142 * | 126 * |
143 * @param candidate The candidate to get the port from. | 127 * @param candidate The candidate to get the port from. |
144 * | 128 * |
145 * @return The port. | 129 * @return The port. |
146 * | |
147 * @since 2.6.0 | |
148 */ | 130 */ |
149 guint16 purple_media_candidate_get_port(PurpleMediaCandidate *candidate); | 131 guint16 purple_media_candidate_get_port(PurpleMediaCandidate *candidate); |
150 | 132 |
151 /** | 133 /** |
152 * Gets the base (internal) IP address. | 134 * Gets the base (internal) IP address. |
154 * This can be NULL. | 136 * This can be NULL. |
155 * | 137 * |
156 * @param candidate The candidate to get the base IP address from. | 138 * @param candidate The candidate to get the base IP address from. |
157 * | 139 * |
158 * @return The base IP address. | 140 * @return The base IP address. |
159 * | |
160 * @since 2.6.0 | |
161 */ | 141 */ |
162 gchar *purple_media_candidate_get_base_ip(PurpleMediaCandidate *candidate); | 142 gchar *purple_media_candidate_get_base_ip(PurpleMediaCandidate *candidate); |
163 | 143 |
164 /** | 144 /** |
165 * Gets the base (internal) port. | 145 * Gets the base (internal) port. |
167 * Invalid if the base IP is NULL. | 147 * Invalid if the base IP is NULL. |
168 * | 148 * |
169 * @param candidate The candidate to get the base port. | 149 * @param candidate The candidate to get the base port. |
170 * | 150 * |
171 * @return The base port. | 151 * @return The base port. |
172 * | |
173 * @since 2.6.0 | |
174 */ | 152 */ |
175 guint16 purple_media_candidate_get_base_port(PurpleMediaCandidate *candidate); | 153 guint16 purple_media_candidate_get_base_port(PurpleMediaCandidate *candidate); |
176 | 154 |
177 /** | 155 /** |
178 * Gets the protocol (TCP or UDP). | 156 * Gets the protocol (TCP or UDP). |
179 * | 157 * |
180 * @param candidate The candidate to get the protocol from. | 158 * @param candidate The candidate to get the protocol from. |
181 * | 159 * |
182 * @return The protocol. | 160 * @return The protocol. |
183 * | |
184 * @since 2.6.0 | |
185 */ | 161 */ |
186 PurpleMediaNetworkProtocol purple_media_candidate_get_protocol( | 162 PurpleMediaNetworkProtocol purple_media_candidate_get_protocol( |
187 PurpleMediaCandidate *candidate); | 163 PurpleMediaCandidate *candidate); |
188 | 164 |
189 /** | 165 /** |
190 * Gets the priority. | 166 * Gets the priority. |
191 * | 167 * |
192 * @param candidate The candidate to get the priority from. | 168 * @param candidate The candidate to get the priority from. |
193 * | 169 * |
194 * @return The priority. | 170 * @return The priority. |
195 * | |
196 * @since 2.6.0 | |
197 */ | 171 */ |
198 guint32 purple_media_candidate_get_priority(PurpleMediaCandidate *candidate); | 172 guint32 purple_media_candidate_get_priority(PurpleMediaCandidate *candidate); |
199 | 173 |
200 /** | 174 /** |
201 * Gets the candidate type. | 175 * Gets the candidate type. |
202 * | 176 * |
203 * @param candidate The candidate to get the candidate type from. | 177 * @param candidate The candidate to get the candidate type from. |
204 * | 178 * |
205 * @return The candidate type. | 179 * @return The candidate type. |
206 * | |
207 * @since 2.6.0 | |
208 */ | 180 */ |
209 PurpleMediaCandidateType purple_media_candidate_get_candidate_type( | 181 PurpleMediaCandidateType purple_media_candidate_get_candidate_type( |
210 PurpleMediaCandidate *candidate); | 182 PurpleMediaCandidate *candidate); |
211 | 183 |
212 /** | 184 /** |
215 * This can be NULL. It depends on the transmission type. | 187 * This can be NULL. It depends on the transmission type. |
216 * | 188 * |
217 * @param The candidate to get the username from. | 189 * @param The candidate to get the username from. |
218 * | 190 * |
219 * @return The username. | 191 * @return The username. |
220 * | |
221 * @since 2.6.0 | |
222 */ | 192 */ |
223 gchar *purple_media_candidate_get_username(PurpleMediaCandidate *candidate); | 193 gchar *purple_media_candidate_get_username(PurpleMediaCandidate *candidate); |
224 | 194 |
225 /** | 195 /** |
226 * Gets the password. | 196 * Gets the password. |
228 * This can be NULL. It depends on the transmission type. | 198 * This can be NULL. It depends on the transmission type. |
229 * | 199 * |
230 * @param The candidate to get the password from. | 200 * @param The candidate to get the password from. |
231 * | 201 * |
232 * @return The password. | 202 * @return The password. |
233 * | |
234 * @since 2.6.0 | |
235 */ | 203 */ |
236 gchar *purple_media_candidate_get_password(PurpleMediaCandidate *candidate); | 204 gchar *purple_media_candidate_get_password(PurpleMediaCandidate *candidate); |
237 | 205 |
238 /** | 206 /** |
239 * Gets the TTL. | 207 * Gets the TTL. |
240 * | 208 * |
241 * @param The candidate to get the TTL from. | 209 * @param The candidate to get the TTL from. |
242 * | 210 * |
243 * @return The TTL. | 211 * @return The TTL. |
244 * | |
245 * @since 2.6.0 | |
246 */ | 212 */ |
247 guint purple_media_candidate_get_ttl(PurpleMediaCandidate *candidate); | 213 guint purple_media_candidate_get_ttl(PurpleMediaCandidate *candidate); |
248 | 214 |
249 G_END_DECLS | 215 G_END_DECLS |
250 | 216 |