Documentation for Kurento JSON-API...

45 views
Skip to first unread message

Russ B

unread,
Jul 8, 2021, 4:26:04 PM7/8/21
to kurento
Is there any documentation or web articles that describe what JSON messages need to be sent over the Kurento WebSocket interface to do one of the following:
- setup a Kurento based SFU web conference
- setup a Kurento based MCU web conference

???

I see examples if what Java or JS calls to setup a Kurento based SFU web conference, but those examples only show the calls to the associated Java or JavaScript libraries that in turn call Kurento.  They do not give any info about what what (JSON) messages are being sent by the Java or JavaScript library to the Kurento server.

   

Juan Navarro

unread,
Jul 9, 2021, 6:32:21 AM7/9/21
to kur...@googlegroups.com
The client libraries are the official way to use Kurento, so in theory the actual underlying JSON messages could change between versions. Which in practice doesn't happen since years. Still, this means that the JSON messages themselves are not explicitly documented.

Note: coincidentally, it just happens that the next release will change a couple of these JSON messages to fix minor typos that were confusing developers. Just changing an "objectID" to "objectId" to be consistent with all the other "Id" that are in the API: Kurento/kms-elements@fe060fc.

You would have 2 routes:

  • Check the source definition of the APIs, from which everything (JSON, client code) is generated: that's the "*.kmd.json" files you could find in Kurento code: kms-core, kms-elements, kms-filters.

  • Write a quick and dirty Java or JavaScript code to get the JSON messages that are sent/received down the line.
--
You received this message because you are subscribed to the Google Groups "kurento" group.
To unsubscribe from this group and stop receiving emails from it, send an email to kurento+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kurento/d144a312-1aea-4fb2-a6df-8a4e3936eaf2n%40googlegroups.com.

Russ B

unread,
Jul 9, 2021, 3:47:32 PM7/9/21
to kurento
Yeah, it would be a lot easier if one of the developers would just publish a Websocket/JSON sec.  
That being said, I will just try to put some sort of logging into the code that I have to see if I can record what the current JSON messages look like.

My thought was that I would use that info to create a C++ client interface library for Kurento.

Micael Gallego

unread,
Jul 9, 2021, 4:31:10 PM7/9/21
to kur...@googlegroups.com
Kurento protocol is documented here:


But every object has a different API, so you have to look to kmd files to know what is the API.

We read the kmd files to generate client code automagically.



Reply all
Reply to author
Forward
0 new messages