Commit f19e09a5 authored by Youness Alaoui's avatar Youness Alaoui

Enhance/fix documentation

parent 9ca1eb42
......@@ -400,18 +400,21 @@ nice_agent_get_local_credentials (
* @component_id: The ID of the component the candidates are for
* @candidates: a #GList of #NiceCandidate items describing each candidate to add
*
* Sets the remote candidates for a component of a stream.
* Replaces any existing remote candidates.
* Sets, adds or updates the remote candidates for a component of a stream.
*
<note>
<para>
NICE_AGENT_MAX_REMOTE_CANDIDATES is the absolute maximum limit
for remote candidates
for remote candidates.
</para>
<para>
You must first call nice_agent_gather_candidates() before
calling nice_agent_set_remote_candidates()
</para>
</note>
*
* Returns: The number of candidates added,
* negative on fatal (memory allocs) errors
* Returns: The number of candidates added, negative on errors (memory allocation
* or if the local candidates are not done gathering yet)
**/
int
nice_agent_set_remote_candidates (
......
......@@ -142,7 +142,7 @@ struct _TurnServer
* @transport: The transport being used for the candidate
* @addr: The #NiceAddress of the candidate
* @base_addr: The #NiceAddress of the base address used by the candidate
* @priority: The priority of the candidate
* @priority: The priority of the candidate <emphasis> see note </emphasis>
* @stream_id: The ID of the stream to which belongs the candidate
* @component_id: The ID of the component to which belongs the candidate
* @foundation: The foundation of the candidate
......@@ -155,6 +155,14 @@ struct _TurnServer
* @sockptr: The underlying socket
*
* A structure to represent an ICE candidate
<note>
<para>
The @priority is an integer as specified in the ICE draft 19. If you are
using the MSN or the GOOGLE compatibility mode (which are based on ICE
draft 6, which uses a floating point qvalue as priority), then the @priority
value will represent the qvalue multiplied by 1000.
</para>
</note>
*/
struct _NiceCandidate
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment