summaryrefslogtreecommitdiff
path: root/agent/agent.h
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.com>2015-04-20 16:08:42 -0400
committerOlivier CrĂȘte <olivier.crete@collabora.com>2015-04-20 16:08:42 -0400
commit483bdcf8c64b8d77e267706df59bfaae4d701380 (patch)
treec6e03806ed81e0edc993691ba3bff832333101ee /agent/agent.h
parent52534c43be1fdc74cd15f64ba28b8e753c212b62 (diff)
agent: Warn on invalid media types for SDP
Only 6 strings are valid. https://bugs.freedesktop.org/show_bug.cgi?id=90019
Diffstat (limited to 'agent/agent.h')
-rw-r--r--agent/agent.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/agent/agent.h b/agent/agent.h
index 5d38839..47c4d5a 100644
--- a/agent/agent.h
+++ b/agent/agent.h
@@ -1253,8 +1253,12 @@ void nice_agent_set_software (
* @stream_id: The ID of the stream to change
* @name: The new name of the stream or %NULL
*
- * This function will assign a unique name to a stream.
- * This is only useful when parsing and generating an SDP of the candidates.
+ * This function will assign a media type to a stream. The only values
+ * that can be used to produce a valid SDP are: "audio", "video",
+ * "text", "application", "image" and "message".
+ *
+ * This is only useful when parsing and generating an SDP of the
+ * candidates.
*
* <para>See also: nice_agent_generate_local_sdp()</para>
* <para>See also: nice_agent_parse_remote_sdp()</para>