Adds track that will be sent to the RTC Engine.
Audio or video track e.g. from your microphone or camera.
Stream that this track belongs to.
Any information about this track that other peers will receive in onPeerJoined. E.g. this can source of the track - wheather it's screensharing, webcam or some other media device.
Simulcast configuration. For more information refer to SimulcastConfig.
maximal bandwidth this track can use. Defaults to 0 which is unlimited. This option has no effect for simulcast and audio tracks.
Returns id of added track
Cleans up MembraneWebRTC instance.
Disables track encoding so that it will be no longer sent to the server.
id of track
encoding that will be disabled
Enables track encoding so that it will be sent to the server.
id of track
encoding that will be enabled
Tries to join to the RTC Engine. If user is accepted then onJoinSuccess will be called. In other case onJoinError is invoked.
Any information that other peers will receive in onPeerJoined after accepting this peer
Leaves the room. This function should be called when user leaves the room
in a clean way e.g. by clicking a dedicated, custom button disconnect
.
As a result there will be generated one more media event that should be
sent to the RTC Engine. Thanks to it each other peer will be notified
that peer left in onPeerLeft,
Prioritizes a track in connection to be always sent to browser.
Id of video track to prioritize.
Feeds media event received from RTC Engine to MembraneWebRTC. This function should be called whenever some media event from RTC Engine was received and can result in MembraneWebRTC generating some other media events.
String data received over custom signalling layer.
Removes a track from connection that was being sent to the RTC Engine.
Id of audio or video track to remove.
Replaces a track that is being sent to the RTC Engine.
Id of audio or video track to replace.
success
Selects track encoding that server should send to the client library.
id of peer that owns track
id of track
encoding to receive
This function allows to adjust resolution and number of video tracks sent by an SFU to a client.
number of screens with big size (if simulcast is used this will limit number of tracks sent with highest quality).
number of screens with small size (if simulcast is used this will limit number of tracks sent with lowest quality).
number of screens with medium size (if simulcast is used this will limit number of tracks sent with medium quality).
flag that indicates whether all screens should use the same quality
Updates maximum bandwidth for the track identified by trackId. This value directly translates to quality of the stream and, in case of video, to the amount of RTP packets being sent. In case trackId points at the simulcast track, bandwidth is split between all of the variant streams proportionally to their resolution.
success
Unprioritizes a track.
Id of video track to unprioritize.
Updates the metadata for the current peer.
Data about this peer that other peers will receive upon joining.
If the metadata is different from what is already tracked in the room, the optional
callback onPeerUpdated
will be triggered for other peers in the room.
Updates the metadata for a specific track.
trackId (generated in addTrack) of audio or video track.
Data about this track that other peers will receive upon joining.
If the metadata is different from what is already tracked in the room, the optional
callback onTrackUpdated
will be triggered for other peers in the room.
Generated using TypeDoc
Main class that is responsible for connecting to the RTC Engine, sending and receiving media.