summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <paul@matrix.org>2014-09-15 14:15:10 +0100
committerPaul "LeoNerd" Evans <paul@matrix.org>2014-09-15 14:15:10 +0100
commitb0406b9ead0e3b726ef2c675181d040ca392e85d (patch)
tree42fdeee7d4b5eb283f6a406463499ae05b9e5ffe /docs/specification.rst
parentMerge remote-tracking branch 'origin/develop' into test-sqlite-memory (diff)
parentCorrectly handle the 'age' key in events and pdus (diff)
downloadsynapse-b0406b9ead0e3b726ef2c675181d040ca392e85d.tar.xz
Merge remote-tracking branch 'origin/develop' into test-sqlite-memory
Diffstat (limited to 'docs/specification.rst')
-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``