summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorDavid Baker <dbkr@matrix.org>2014-09-12 18:18:35 +0100
committerDavid Baker <dbkr@matrix.org>2014-09-12 18:19:19 +0100
commit21b45d2a5b8bd00cec9fa634cb8cc87b70e7c05c (patch)
treec17d4621b3c90c78663dc2e2511ec28b141125f3 /docs/specification.rst
parentSend multiple candidates at once instead of all individually. Changes spec to... (diff)
downloadsynapse-21b45d2a5b8bd00cec9fa634cb8cc87b70e7c05c.tar.xz
Update the spec document to replace the candidate message with the candidates message.
Diffstat (limited to '')
-rw-r--r--docs/specification.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index aad200c04d..ab16a0bb68 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -1182,16 +1182,16 @@ This event is sent by the caller when they wish to establish a call.
     - ``type`` : "string" - The type of session description, in this case 'offer'
     - ``sdp`` : "string" - The SDP text of the session description
 
-``m.call.candidate``
+``m.call.candidates``
 This event is sent by callers after sending an invite and by the callee after answering.
-Its purpose is to give the other party an additional ICE candidate to try using to
+Its purpose is to give the other party additional ICE candidates to try using to
 communicate.
 
   Required keys:
     - ``call_id`` : "string" - The ID of the call this event relates to
     - ``version`` : "integer" - The version of the VoIP specification this messages
                                 adheres to. his specification is version 0.
-    - ``candidate`` : "candidate object" - Object describing the candidate.
+    - ``candidates`` : "array of candidate objects" - Array of object describing the candidates.
 
 ``Candidate Object``