ConsumerOptions.rtpCapabilities field is not optional

[nazar-pc]

It is also not optional according to documentation

[ibc]

Not accurate. In fact, if you run npm run typescript:watch it will fail:

src/Router.ts:743:53 - error TS2345: Argument of type '{ producerId: string; }' is not assignable to parameter of type 'ConsumerOptions'.
  Property 'rtpCapabilities' is missing in type '{ producerId: string; }' but required in type 'ConsumerOptions'.

743  			pipeConsumer = await localPipeTransport.consume({ producerId });
     			                                                ~~~~~~~~~~~~~~

  src/Consumer.ts:21:2
    21  rtpCapabilities: RtpCapabilities;
        ~~~~~~~~~~~~~~~
    'rtpCapabilities' is declared here.

[5:13:05 PM] Found 1 error. Watching for file changes.

This is because, in pipeTransport.consume(), field rtpCapabilities is not needed and not given.

[nazar-pc]

Then it is documentation issue?
https://mediasoup.org/documentation/v3/mediasoup/api/#ConsumerOptions

Either way having optional field for WebRTC Transport where it is not optional is confusing.

[ibc]

Yep, the API doc should be fixed. I've reported it and will fix eventually:

versatica/mediasoup-website#14

Thanks.