Commit 483a0fcc authored by Philip Withnall's avatar Philip Withnall Committed by Olivier Crête

agent: Clarify valid range of stream and component IDs

Valid IDs will never be 0, which is convenient.
parent 19679283
......@@ -53,6 +53,10 @@
* It will take care of discovering your local candidates and do
* connectivity checks to create a stream of data between you and your peer.
*
* Streams and their components are referenced by integer IDs (with respect to a
* given #NiceAgent). These IDs are guaranteed to be positive (i.e. non-zero)
* for valid streams/components.
*
<example>
<title>Simple example on how to use libnice</title>
<programlisting>
......@@ -338,7 +342,8 @@ nice_agent_add_local_address (NiceAgent *agent, NiceAddress *addr);
* @agent: The #NiceAgent Object
* @n_components: The number of components to add to the stream
*
* Adds a data stream to @agent containing @n_components components.
* Adds a data stream to @agent containing @n_components components. The
* returned stream ID is guaranteed to be positive on success.
*
* Returns: The ID of the new stream, 0 on failure
**/
......
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