Code autogenerated from Kurento/doc-kurento@e4f5d60

source/langdoc/client-jsdoc/lib_index.js.html

@@ -84,9 +84,9 @@ <h1 class="page-title">Source: lib/index.js</h1>
 
 // Register Kurento basic elements
 
-register('kurento-client-core')
-register('kurento-client-elements')
-register('kurento-client-filters')
+register(require('kurento-client-core'))
+register(require('kurento-client-elements'))
+register(require('kurento-client-filters'))
 </code></pre>
         </article>
     </section>

source/user/troubleshooting.rst

@@ -357,8 +357,8 @@ This is how this process would look like. In this example, KMS was restarted so
 
 
 
-Node.js / NPM failures
-----------------------
+Node / NPM failures
+-------------------
 
 Kurento Client does not currently support Node v10 (LTS), you will have to use Node v8 or below.
 
@@ -393,6 +393,39 @@ The solution is to ensure that both peers are able to find a match in their supp
 
 
 
+"Error: 'operationParams' is required"
+--------------------------------------
+
+This issue is commonly caused by setting an invalid ID to any of the client method calls. The usual solution is to provide a null identifier, forcing the server to generate a new one for the object.
+
+For example, a Node application wanting to use the ImageOverlayFilter might try to provide an ID in the ``addImage()`` call:
+
+.. code-block:: js
+
+   const filter = await pipeline.create("ImageOverlayFilter");
+   await filter.addImage("IMAGE_ID", "https://IMAGE_URL", 0.5, 0.5, 0.5, 0.5, true, true );
+   await webRtcEndpoint.connect(filter);
+   await filter.connect(webRtcEndpoint);
+
+This will fail, causing a *MARSHALL_ERROR* in the media server, and showing the following stack trace in the client side:
+
+.. code-block:: text
+
+   Trace: { Error: 'operationParams' is required
+       at node_modules/kurento-client/lib/KurentoClient.js:373:24
+       at Object.dispatchCallback [as callback] (node_modules/kurento-jsonrpc/lib/index.js:546:9)
+       at processResponse (node_modules/kurento-jsonrpc/lib/index.js:667:15)
+       [...]
+       at WebsocketStream.onMessage (node_modules/websocket-stream/index.js:45:15) code: 40001, data: { type: 'MARSHALL_ERROR' } }
+
+The solution is simply using ``null`` for the ID:
+
+.. code-block:: js
+
+   await filter.addImage(null, "https://IMAGE_URL", 0.5, 0.5, 0.5, 0.5, true, true );
+
+
+
 .. _troubleshooting-webrtc:
 
 WebRTC failures