handbook icon indicating copy to clipboard operation
handbook copied to clipboard

Incomplete documentation

Open xXTraceXx opened this issue 3 years ago • 3 comments

Hello,

i am working with lib-jitsi-meet. I found the setReceiverVideoConstraint(resolution) in the documation (lib-jitsi-meet API (low level) | Jitsi Meet ) but it feels incomplete to me. The argument resolution for example is not really documented and i dont’t know if it is a object or a string, just to mention two examples.

Same with the effect object in the method setEffect method. I guess a lot of developers have to guess what u mean by effect or resolution.

If you give me the necessary information i will do an improved version of the documetion via pull request.

Thanks for your work

xXTraceXx avatar Apr 08 '22 13:04 xXTraceXx

Ping @jallamsetty1 iin case you have some spare cycles...

saghul avatar May 06 '22 15:05 saghul

I will add this to my list. Also, setReceiverVideoConstraint is deprecated and one should instead use setReceiverConstraints

jallamsetty1 avatar May 10 '22 18:05 jallamsetty1

did you changed the code,

abhijain2003 avatar Feb 04 '23 17:02 abhijain2003