Static
optionsRemoved given peer connection from this RTC module instance.
true if the given peer connection was removed successfully or false if there was no peer connection mapped in this RTC instance.
Adds new cancellable listener.
the name of the event
the listener.
Alias for on method.
The event ID.
Handler for the event.
Adds new listener.
the name of the event
the listener.
Closes the currently opened bridge channel.
Creates new TraceablePeerConnection
The signaling layer that will provide information about the media or participants which is not carried over SDP.
The {@code RTCConfiguration} to use for the WebRTC peer connection.
Indicates whether or not the new TPC will be used in a peer to peer type of session.
The config options.
Quality settings to applied on the outbound audio stream.
if set to true, lower layers will be disabled for screenshare.
codec settings to be applied for video streams.
if set to 'true' will disable the RTX.
if set to 'true' will disable the simulcast.
set to true when the insertable streams constraints is to be enabled on the PeerConnection.
If set to true, the browser will generate only Relay ICE candidates.
If set to 'true' no audio will be sent or received.
Quality settings to applied on the outbound video streams.
Removes any listeners and stored state from this {@code RTC} instance.
Emits an event.
event name
Get forwarded sources list.
Get local audio track.
Returns the endpoint id for the local user.
Returns the local tracks of the given media type, or all local tracks if no specific type is given.
Optional
mediaType: MediaTypeOptional media type filter. (audio or video).
Get local video track.
Returns all the local video tracks.
Obtains all remote tracks currently known to this RTC module instance.
Optional
mediaType: MediaTypeThe remote tracks will be filtered by their media type if this argument is specified.
Initializes the bridge channel of this instance. At least one of both, peerconnection or wsUrl parameters, must be given.
Optional
peerconnection: RTCPeerConnectionWebRTC peer connection instance.
Optional
wsUrl: stringWebSocket URL.
Indicates if the source name is currently included in the forwarded sources.
The source name that we check for forwarded sources.
true if the source name is in the forwarded sources or if we don't have bridge channel support, otherwise we return false.
Returns the number of listeners for the specified event.
Optional
eventName: stringThe name of the event.
Removes event listener.
The event ID.
Optional
handler: EventListenerOptional, the specific handler to unbind.
Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.
The event ID.
Handler for the event.
Should be called when current media session ends and after the PeerConnection has been closed using PeerConnection.close() method.
Adds a one-time listener function for the event.
The event ID.
Handler for the event.
Removes all listeners for the event emitter.
Alias for off method.
The event ID.
Optional
handler: EventListenerOptional, the specific handler to unbind.
Removes listener.
the name of the event that triggers the listener
the listener.
Sends message via the bridge channel.
The id of the endpoint that should receive the message. If "" the message will be sent to all participants.
The payload of the message.
Sends a receiver audio subscription message.
Sends the track's video type to the JVB.
the track's source name.
the track's video type.
Set mute for all local audio streams attached to the conference.
Set mute for all local desktop video streams attached to the conference.
Sets the capture frame rate to be used for desktop tracks.
framerate to be used for desktop track capture.
Selects a new value for "lastN". The requested amount of videos are going to be delivered after the value is in effect. Set to -1 for unlimited or all available videos.
the new value for lastN.
Sets the receiver video constraints that determine how bitrate is allocated to each of the video streams requested from the bridge. The constraints are cached and sent through the bridge channel once the channel is established.
Set mute for all local video streams attached to the conference.
Static
addStatic
attachStatic
createExposes the private helper for converting a WebRTC MediaStream to a JitsiLocalTrack.
Static
enumerateAllows to receive list of available cameras/microphones.
Would receive array of devices as an argument.
Static
getReturns currently used audio output device id, '' stands for default device
Static
getReturns list of available media devices if its obtained, otherwise an empty array is returned/
list of available media devices.
Static
getReturns event data for device to be reported to stats.
device.
Static
initStatic
isReturns whether the desktop sharing is enabled or not.
Static
isReturns true if changing the input (camera / microphone) or output (audio) device is supported and false if not.
Optional
deviceType: stringType of device to change. Default is undefined or 'input', 'output' - for audio output device change.
true if available, false otherwise.
Static
isReturns whether the current execution environment supports WebRTC (for use within this library).
{@code true} if WebRTC is supported in the current execution environment (for use within this library); {@code false}, otherwise.
Static
obtainCreates the local MediaStreams.
Optional
options: {Optional parameters.
Optional
cameraDeviceId?: stringOptional
devices?: any[]The devices that will be requested.
Optional
micDeviceId?: stringOptional
resolution?: stringResolution constraints.
Promise object that will receive the new JitsiTracks
Static
removeStatic
setSets current audio output device.
Id of 'audiooutput' device from navigator.mediaDevices.enumerateDevices().
resolves when audio output is changed, is rejected otherwise
Static
stopA method to handle stopping of the stream. One point to handle the differences in various implementations.
MediaStream object to stop.
A map of active TraceablePeerConnection.