Ver Fonte

Merge pull request #207 from emersion/patch-2

Update api.json
Michelle Bu há 11 anos atrás
pai
commit
d7dae576c7
1 ficheiros alterados com 13 adições e 2 exclusões
  1. 13 2
      docs/api.json

+ 13 - 2
docs/api.json

@@ -120,7 +120,7 @@
     "name": "peer.call",
     "tags": ["beta (0.3.0)"],
     "type": "method",
-    "snippet": "var <a href='#mediaconnection'>mediaConnection</a> = peer.call(id, stream);",
+    "snippet": "var <a href='#mediaconnection'>mediaConnection</a> = peer.call(id, stream, [options]);",
     "description": "Calls the remote peer specified by <code>id</code> and returns a media connection. Be sure to listen on the <a href='#peeron-error'><code>error</code></a> event in case the connection fails.",
     "children": [
       {
@@ -131,7 +131,18 @@
       {
         "name": "stream",
         "type": "MediaStream",
-        "description": "Something else"
+        "description": "The caller's media stream"
+      },
+      {
+        "name": "options",
+        "optional": true,
+        "type": "object",
+        "children": [
+          {
+            "name": "metadata",
+            "description": "Metadata associated with the connection, passed in by whoever initiated the connection. Can be accessed with <a href='#dataconnection-metadata'><code>dataConnection.metadata</code></a>. Can be any serializable type."
+          }
+        ]
       }
     ]
   },