Commit 9c5f3010 authored by Philip Withnall's avatar Philip Withnall Committed by Olivier Crête

agent: Expand documentation for a couple of NiceAgent functions

Expand documentation for nice_agent_gather_candidates() and
nice_agent_set_remote_credentials().
parent ac4d1b7f
...@@ -496,17 +496,23 @@ gboolean nice_agent_set_relay_info( ...@@ -496,17 +496,23 @@ gboolean nice_agent_set_relay_info(
/** /**
* nice_agent_gather_candidates: * nice_agent_gather_candidates:
* @agent: The #NiceAgent Object * @agent: The #NiceAgent object
* @stream_id: The id of the stream to start * @stream_id: The ID of the stream to start
*
* Allocate and start listening on local candidate ports and start the remote
* candidate gathering process.
* Once done, #NiceAgent::candidate-gathering-done is called for the stream.
* As soon as this function is called, #NiceAgent::new-candidate signals may be
* emitted, even before this function returns.
* *
* Start the candidate gathering process. * nice_agent_get_local_candidates() will only return non-empty results after
* Once done, #NiceAgent::candidate-gathering-done is called for the stream * calling this function.
* *
* <para>See also: nice_agent_add_local_address()</para> * <para>See also: nice_agent_add_local_address()</para>
* <para>See also: nice_agent_set_port_range()</para> * <para>See also: nice_agent_set_port_range()</para>
* *
* Returns: %FALSE if the stream id is invalid or if a host candidate couldn't be allocated * Returns: %FALSE if the stream ID is invalid or if a host candidate couldn't
* on the requested interfaces/ports. * be allocated on the requested interfaces/ports; %TRUE otherwise
* *
<note> <note>
<para> <para>
...@@ -555,14 +561,16 @@ nice_agent_set_remote_credentials ( ...@@ -555,14 +561,16 @@ nice_agent_set_remote_credentials (
* nice_agent_get_local_credentials: * nice_agent_get_local_credentials:
* @agent: The #NiceAgent Object * @agent: The #NiceAgent Object
* @stream_id: The ID of the stream * @stream_id: The ID of the stream
* @ufrag: a pointer to a NULL-terminated string containing * @ufrag: (out callee-allocates): return location for a nul-terminated string
* an ICE username fragment [OUT]. * containing an ICE username fragment; must be freed with g_free()
* This string must be freed with g_free() * @pwd: (out callee-allocates): return location for a nul-terminated string
* @pwd: a pointer to a NULL-terminated string containing an ICE * containing an ICE password; must be freed with g_free()
* password [OUT] *
* This string must be freed with g_free() * Gets the local credentials for stream @stream_id. This may be called any time
* * after creating a stream using nice_agent_add_stream().
* Gets the local credentials for stream @stream_id. *
* An error will be returned if this is called for a non-existent stream, or if
* either of @ufrag or @pwd are %NULL.
* *
* Returns: %TRUE on success, %FALSE on error. * Returns: %TRUE on success, %FALSE on error.
*/ */
......
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