DeviceInfo

mediasoupClient.internals

Exposes the internals property.

mediasoupClient.setDeviceHandler(handler, metadata)

Set a custom device handler that mediasoup-client will use instead of any builtin one.

mediasoupClient.isDeviceSupported()

Returns a Boolean indicating if the current browser/device is supported by mediasoup-client.

mediasoupClient.getDeviceInfo()

Returns a DeviceInfo Object with the browser/device information.

mediasoupClient.checkCapabilitiesForRoom(roomRtpCapabilities)

Checks the audio/video capabilities of the current device/browser for the remote room given its RTP capabilities.

It returns a Promise that resolves to an Object with audio and video Booleans, indicating whether sending and receiving audio/video is possible once joined in that room.

mediasoupClient.Room

Exposes the Room class.

RoomOptions

Usage example:

const room = mediasoupClient.Room(
  {
    requestTimeout : 8000
  });

room.joined

• Read only

A Boolean indicating whether the room has been joined.

room.closed

• Read only

A Boolean indicating whether the room has been closed.

room.peerName

• Read only.

An String representing the name of own our Peer.

room.transports

• Read only

An Array with our list of Transport instances in the room.

room.producers

• Read only

An Array with our list of Producer instances in the room.

room.peers

• Read only

An Array with the list of remote Peer instances in the room.

room.join(peerName, [appData])

Start the procedures to join a remote room. Returns a Promise resolving with an Array of remote Peer instances already in the room.

Usage example:

room.join("alice")
  .then((peers) =>
  {
    console.info("room joined");
  });

room.leave([appData])

Leaves the room and triggers a close event.

room.receiveNotification(notification)

Receive a mediasoup protocol notification payload (generated by mediasoup).

The method does not return anything.

room.canSend(kind)

Whether we can send the given kind of media (it depends on the available room and device codecs).

room.createTransport(direction, [appData])

Creates a new Transport for sending or receiving audio/video.

room.createProducer(track, [options], [appData])

Creates a new Producer for the given audio/video track.

Usage example:

let micProducer;
let webcamProducer;

navigator.mediaDevices.getUserMedia({ audio: true, video: true })
  .then((stream) =>
  {
    const audioTrack = stream.getAudioTracks()[0];
    const videoTrack = stream.getVideoTracks()[0];

    micProducer = room.createProducer(audioTrack);
    webcamProducer = room.createProducer(videoTrack);
  });

room.restartIce()

Restarts all the Transport instances by following ICE rules. Useful when detecting IP change.

room.getTransportById(name)

Retrieves the Transport with the given id, or undefined if not found.

room.getProducerById(name)

Retrieves the Producer with the given id, or undefined if not found.

room.getPeerByName(name)

Retrieves the remote Peer with the given name, or undefined if not found.

room.on(“close”, fn(appData))

Emitted when the room is closed or when our peer leaves it.

room.on(“request”, fn(request, callback, errback))

Emitted when a new mediasoup protocol request must be sent to mediasoup.

Usage example:

room.on("request", (request, callback, errback) =>
{
  myChannel.send({ type: "mediasoup-request", body: request })
    .then((response) =>
    {
      // Success response, so pass the mediasoup response to the local Room.
      callback(response.body);
    })
    .catch((error) =>
    {
      // Error response, so pass the error to the local Room.
      errback(error);
    });
});

room.on(“notify”, fn(notification))

Emitted when a new mediasoup protocol notification must be sent to mediasoup.

Usage example:

room.on("notify", (notification) =>
{
  myChannel.send({ type: 'mediasoup-notification', body: notification });
});

room.on(“newpeer”, fn(peer))

Emitted when a new remote peer joins the room.

TransportOptions

Options for a Transport in mediasoup (server side).

ConnectionState

transport.id

• Read only

Unique identifier (Number).

transport.closed

• Read only

A Boolean indicating whether the transport has been closed.

transport.appData

• Read-write

Custom data set by the application.

transport.direction

• Read only

A String (“send” or “recv”) representing the direction of the media over this transport.

transport.connectionState

• Read only

The ConnectionState of the underlying RTCPeerConnection or RTCIceTransport.

transport.handler

• Read only

The DeviceHandler used by the transport.

transport.close([appData])

Closes the transport and triggers a close event.

transport.enableStats([interval = 1000])

Subscribes the transport to RTC stats retrieved via the stats event.

transport.disableStats()

Closes the subscription to RTC stats for this transport.

transport.on(“close”, fn(originator, appData))

Emitted when the transport is closed.

transport.on(“connectionstatechange”, fn(connectionstate))

Emitted when the underlying ICE connection state changes.

transport.on(“stats”, fn(stats))

Emitted when RTC stats are retrieved.

ProducerOptions

SimulcastOptions

Options for simulcast streams.

producer.id

• Read only

Unique identifier (Number).

producer.closed

• Read only

A Boolean indicating whether the producer has been closed.

producer.appData

• Read-write

Custom data set by the application.

producer.kind

• Read only

The media kind (“audio” or “video”) handled by the producer.

producer.track

• Read only

The MediaStreamTrack internally handled by the producer.

producer.originalTrack

• Read only

The original MediaStreamTrack given to the producer (not internally used).

producer.transport

• Read only

The Transport assigned to this producer (if any).

producer.rtpParameters

• Read only

An Object with the effective RTP parameters of the producer, miming the syntax of RTCRtpParameters in ORTC.

producer.locallyPaused

• Read only

Boolean indicating whether this producer has been locally paused.

producer.remotelyPaused

• Read only

Boolean indicating whether this producer has been remotely paused.

producer.paused

• Read only

Boolean indicating whether this producer has been locally or remotely paused.

producer.close([appData])

Closes the producer and triggers a close event.

producer.send(transport)

Enables sending RTP for this producer by providing a transport. It returns a Promise.

producer.pause([appData])

Pauses the producer locally, meaning that no RTP will be sent to the room.

producer.resume([appData])

Resumes the producer locally, meaning that RTP will be relayed again to the room (unless the producer was also remotely paused).

producer.replaceTrack(track)

Replaces the audio/video track being sent to the room.

producer.enableStats([interval = 1000])

Subscribes the producer to RTC stats retrieved via the stats event.

producer.disableStats()

Closes the subscription to RTC stats for this producer.

producer.on(“close”, fn(originator, appData))

Emitted when the producer is closed.

producer.on(“pause”, fn(originator, appData))

Emitted when the producer is locally or remotely paused.

producer.on(“resume”, fn(originator, appData))

Emitted when the producer is locally or remotely resumed.

producer.on(“trackended”, fn())

Emitted when the internally managed track's is stopped (useful to detect microphone or webcam disconnection/failures). The producer is not automatically closed (it's up to the application to close it or not).

producer.on(“handled”, fn())

Emitted when a transport is given to this producer.

producer.on(“unhandled”, fn())

Emitted when the associated transport is closed.

producer.on(“stats”, fn(stats))

Emitted when RTC stats are retrieved.

peer.name

• Read only

The name (String) of the remote peer.

peer.closed

• Read only

A Boolean indicating whether the peer has been closed.

peer.appData

• Read-write

Custom data set by the remote application.

peer.consumers

• Read only

An Array with the list of Consumer instances associated to the remote peer in the order in which they were created.

peer.getConsumerById(id)

Retrieves the Consumer with the given id, or undefined if not found.

peer.on(“close”, fn())

Emitted when the remote peer is closed or leaves the room.

peer.on(“newconsumer”, fn(consumer))

Emitted when a new consumer is created for receiving new media produced by the remote peer.

consumer.id

• Read only

Unique identifier (Number).

consumer.closed

• Read only

A Boolean indicating whether the consumer has been closed.

consumer.appData

• Read-write

Custom data set by the application.

consumer.kind

• Read only

The media kind (“audio” or “video”) handled by the consumer.

consumer.rtpParameters

• Read only

An Object with the effective RTP parameters of the consumer, miming the syntax of RTCRtpParameters in ORTC.

consumer.track

• Read only

The MediaStreamTrack internally handled by the consumer.

It is undefined if receive() was not called before.

consumer.peer

• Read only

The remote Peer instance producing the media.

It is undefined if this is not a Consumer associated to a remote peer.

consumer.supported

• Read only

A Boolean indicating whether our browser/device can enable this Consumer. If we don't support the audio/video codec this won't be true.

consumer.transport

• Read only

The Transport assigned to this consumer (if any).

consumer.locallyPaused

• Read only

Boolean indicating whether this consumer has been locally paused.

consumer.remotelyPaused

• Read only

Boolean indicating whether this consumer has been remotely paused.

consumer.paused

• Read only

Boolean indicating whether this consumer has been locally or remotely paused.

consumer.preferredProfile

• Read only

String indicating the preferred RTP profile set via consumer.setPreferredProfile().

consumer.effectiveProfile

• Read only

String indicating the effective current RTP profile of this consumer.

consumer.close([appData])

Closes the consumer and triggers a close event.

consumer.receive(transport)

Enables receiving RTP for this consumer by providing a transport. It returns a Promise resolving to a remote MediaStreamTrack.

Usage example:

const stream = new MediaStream();

consumer.receive(recvTransport)
  .then((track) =>
  {
    stream.addTrack(track);
    videoElem.srcObject = stream;
  });

consumer.pause([appData])

Pauses the consumer locally, meaning that no RTP will be received from the room.

consumer.resume([appData])

Resumes the consumer locally, meaning that RTP will be received again from the room (unless the consumer or its remote source was also remotely paused).

consumer.setPreferredProfile(profile)

Set the given RTP profile as the desired profile. No profile higher than the given one will become effective profile for this consumer.

For more information, check the Glossary section.

consumer.enableStats([interval = 1000])

Subscribes the consumer to RTC stats retrieved via the stats event.

consumer.disableStats()

Closes the subscription to RTC stats for this consumer.

consumer.on(“close”, fn(originator, appData))

Emitted when the consumer is closed.

consumer.on(“pause”, fn(originator, appData))

Emitted when the consumer is locally or remotely paused.

consumer.on(“resume”, fn(originator, appData))

Emitted when the consumer is locally or remotely resumed.

consumer.on(“effectiveprofilechange”, fn(profile))

Emitted when the effective profile changes.

consumer.on(“handled”, fn())

Emitted when a transport is given to this consumer.

consumer.on(“unhandled”, fn())

Emitted when the associated transport is closed.

consumer.on(“stats”, fn(stats))

Emitted when RTC stats are retrieved.