Class RTC

constructor

• new RTC(conference: any, options?: {}): RTC

  Parameters

  • conference: any
  • options: {} = {}

  Returns RTC

_channel

_channelOpenListener

_forwardedSourcesChangeListener

_receiverVideoConstraints

conference

localTracks

options

peerConnections

Staticoptions

_removePeerConnection

• _removePeerConnection(traceablePeerConnection: TraceablePeerConnection): boolean

  Removed given peer connection from this RTC module instance.

  Parameters

  • traceablePeerConnection: TraceablePeerConnection

  Returns boolean

  true if the given peer connection was removed successfully or false if there was no peer connection mapped in this RTC instance.

addLocalTrack

• addLocalTrack(track: any): void

  Parameters

  • track: any

  Returns void

closeBridgeChannel

• closeBridgeChannel(): void

  Closes the currently opened bridge channel.

  Returns void

createPeerConnection

• createPeerConnection(
      signaling: SignalingLayer,
      pcConfig: any,
      isP2P: boolean,
      options: {
          audioQuality: any;
          capScreenshareBitrate: boolean;
          codecSettings: CodecMimeType[];
          disableRtx: boolean;
          disableSimulcast: boolean;
          enableInsertableStreams: boolean;
          forceTurnRelay: boolean;
          startSilent: boolean;
          videoQuality: any;
      },
  ): TraceablePeerConnection

  Creates new TraceablePeerConnection

  Parameters

  • signaling: SignalingLayer

    The signaling layer that will provide information about the media or participants which is not carried over SDP.
  • pcConfig: any

    The {@code RTCConfiguration} to use for the WebRTC peer connection.
  • isP2P: boolean

    Indicates whether or not the new TPC will be used in a peer to peer type of session.
  • options: {
        audioQuality: any;
        capScreenshareBitrate: boolean;
        codecSettings: CodecMimeType[];
        disableRtx: boolean;
        disableSimulcast: boolean;
        enableInsertableStreams: boolean;
        forceTurnRelay: boolean;
        startSilent: boolean;
        videoQuality: any;
    }

    The config options.

    • audioQuality: any

      Quality settings to applied on the outbound audio stream.

    • capScreenshareBitrate: boolean

      if set to true, lower layers will be disabled for screenshare.

    • codecSettings: CodecMimeType[]

      codec settings to be applied for video streams.

    • disableRtx: boolean

      if set to 'true' will disable the RTX.

    • disableSimulcast: boolean

      if set to 'true' will disable the simulcast.

    • enableInsertableStreams: boolean

      set to true when the insertable streams constraints is to be enabled on the PeerConnection.

    • forceTurnRelay: boolean

      If set to true, the browser will generate only Relay ICE candidates.

    • startSilent: boolean

      If set to 'true' no audio will be sent or received.

    • videoQuality: any

      Quality settings to applied on the outbound video streams.

  Returns TraceablePeerConnection

destroy

• destroy(): void

  Removes any listeners and stored state from this {@code RTC} instance.

  Returns void

getForwardedSources

• getForwardedSources(): string[]

  Get forwarded sources list.

  Returns string[]

getLocalAudioTrack

• getLocalAudioTrack(): JitsiLocalTrack

  Get local audio track.

  Returns JitsiLocalTrack

getLocalEndpointId

• getLocalEndpointId(): string

  Returns the endpoint id for the local user.

  Returns string

getLocalTracks

• getLocalTracks(mediaType?: MediaType): any[]

  Returns the local tracks of the given media type, or all local tracks if no specific type is given.

  Parameters

  • OptionalmediaType: MediaType

    Optional media type filter. (audio or video).

  Returns any[]

getLocalVideoTrack

• getLocalVideoTrack(): JitsiLocalTrack

  Get local video track.

  Returns JitsiLocalTrack

getLocalVideoTracks

• getLocalVideoTracks(): JitsiLocalTrack[]

  Returns all the local video tracks.

  Returns JitsiLocalTrack[]

getRemoteTracks

• getRemoteTracks(mediaType?: MediaType): JitsiRemoteTrack[]

  Obtains all remote tracks currently known to this RTC module instance.

  Parameters

  • OptionalmediaType: MediaType

    The remote tracks will be filtered by their media type if this argument is specified.

  Returns JitsiRemoteTrack[]

initializeBridgeChannel

• initializeBridgeChannel(
      peerconnection?: RTCPeerConnection,
      wsUrl?: string,
  ): void

  Initializes the bridge channel of this instance. At least one of both, peerconnection or wsUrl parameters, must be given.

  Parameters

  • Optionalpeerconnection: RTCPeerConnection

    WebRTC peer connection instance.
  • OptionalwsUrl: string

    WebSocket URL.

  Returns void

isInForwardedSources

• isInForwardedSources(sourceName: string): boolean

  Indicates if the source name is currently included in the forwarded sources.

  Parameters

  • sourceName: string

    The source name that we check for forwarded sources.

  Returns boolean

  true if the source name is in the forwarded sources or if we don't have bridge channel support, otherwise we return false.

onCallEnded

• onCallEnded(): void

  Should be called when current media session ends and after the PeerConnection has been closed using PeerConnection.close() method.

  Returns void

removeLocalTrack

• removeLocalTrack(track: any): void

  Parameters

  • track: any

  Returns void

sendChannelMessage

• sendChannelMessage(to: string, payload: any): void

  Sends message via the bridge channel.

  Parameters

  • to: string

    The id of the endpoint that should receive the message. If "" the message will be sent to all participants.
  • payload: any

    The payload of the message.

  Returns void

  Throws

  NetworkError or InvalidStateError or Error if the operation fails or there is no data channel created.

sendEndpointStatsMessage

• sendEndpointStatsMessage(payload: any): void

  Sends the local stats via the bridge channel.

  Parameters

  • payload: any

    The payload of the message.

  Returns void

  Throws

  NetworkError/InvalidStateError/Error if the operation fails or if there is no data channel created.

sendReceiverAudioSubscriptionMessage

• sendReceiverAudioSubscriptionMessage(message: any): void

  Sends a receiver audio subscription message.

  Parameters

  • message: any

  Returns void

sendSourceVideoType

• sendSourceVideoType(sourceName: SourceName, videoType: BridgeVideoType): void

  Sends the track's video type to the JVB.

  Parameters

  • sourceName: SourceName

    the track's source name.
  • videoType: BridgeVideoType

    the track's video type.

  Returns void

setAudioLevel

• setAudioLevel(
      tpc: TraceablePeerConnection,
      ssrc: number,
      audioLevel: number,
      isLocal: boolean,
  ): void

  Parameters

  • tpc: TraceablePeerConnection
  • ssrc: number
  • audioLevel: number
  • isLocal: boolean

  Returns void

setAudioMute

• setAudioMute(): Promise<any>

  Set mute for all local audio streams attached to the conference.

  Returns Promise<any>

setDesktopMute

• setDesktopMute(): Promise<any>

  Set mute for all local desktop video streams attached to the conference.

  Returns Promise<any>

setDesktopSharingFrameRate

• setDesktopSharingFrameRate(maxFps: number): void

  Sets the capture frame rate to be used for desktop tracks.

  Parameters

  • maxFps: number

    framerate to be used for desktop track capture.

  Returns void

setLastN

• setLastN(value: number): void

  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.

  Parameters

  • value: number

    the new value for lastN.

  Returns void

setReceiverVideoConstraints

• setReceiverVideoConstraints(constraints: any): void

  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.

  Parameters

  • constraints: any

  Returns void

setVideoMute

• setVideoMute(): Promise<any>

  Set mute for all local video streams attached to the conference.

  Returns Promise<any>

StaticaddListener

• addListener(eventType: any, listener: any): void

  Parameters

  • eventType: any
  • listener: any

  Returns void

StaticattachMediaStream

• attachMediaStream(elSelector: any, stream: any): any

  Parameters

  • elSelector: any
  • stream: any

  Returns any

StaticcreateLocalTracks

• createLocalTracks(tracksInfo: any[]): JitsiLocalTrack[]

  Exposes the private helper for converting a WebRTC MediaStream to a JitsiLocalTrack.

  Parameters

  • tracksInfo: any[]

  Returns JitsiLocalTrack[]

StaticenumerateDevices

• enumerateDevices(callback: Function): void

  Allows to receive list of available cameras/microphones.

  Parameters

  • callback: Function

    Would receive array of devices as an argument.

  Returns void

StaticgetAudioOutputDevice

• getAudioOutputDevice(): string

  Returns currently used audio output device id, '' stands for default device

  Returns string

StaticgetCurrentlyAvailableMediaDevices

• getCurrentlyAvailableMediaDevices(): any[]

  Returns list of available media devices if its obtained, otherwise an empty array is returned/

  Returns any[]

  list of available media devices.

StaticgetEventDataForActiveDevice

• getEventDataForActiveDevice(device: any): MediaDeviceInfo

  Returns event data for device to be reported to stats.

  Parameters

  • device: any

  Returns MediaDeviceInfo

  device.

Staticinit

• init(options?: {}): void

  Parameters

  • options: {} = {}

  Returns void

StaticisDesktopSharingEnabled

• isDesktopSharingEnabled(): boolean

  Returns whether the desktop sharing is enabled or not.

  Returns boolean

StaticisDeviceChangeAvailable

• isDeviceChangeAvailable(deviceType?: string): boolean

  Returns true if changing the input (camera / microphone) or output (audio) device is supported and false if not.

  Parameters

  • OptionaldeviceType: string

    Type of device to change. Default is undefined or 'input', 'output' - for audio output device change.

  Returns boolean

  true if available, false otherwise.

StaticisWebRtcSupported

• isWebRtcSupported(): boolean

  Returns whether the current execution environment supports WebRTC (for use within this library).

  Returns boolean

  {@code true} if WebRTC is supported in the current execution environment (for use within this library); {@code false}, otherwise.

StaticobtainAudioAndVideoPermissions

• obtainAudioAndVideoPermissions(
      options?: {
          cameraDeviceId?: string;
          devices?: any[];
          micDeviceId?: string;
          resolution?: string;
      },
  ): any

  Creates the local MediaStreams.

  Parameters

  • Optionaloptions: {
        cameraDeviceId?: string;
        devices?: any[];
        micDeviceId?: string;
        resolution?: string;
    }

    Optional parameters.

    • OptionalcameraDeviceId?: string

    • Optionaldevices?: any[]

      The devices that will be requested.

    • OptionalmicDeviceId?: string

    • Optionalresolution?: string

      Resolution constraints.

  Returns any

  Promise object that will receive the new JitsiTracks

StaticremoveListener

• removeListener(eventType: any, listener: any): void

  Parameters

  • eventType: any
  • listener: any

  Returns void

StaticsetAudioOutputDevice

• setAudioOutputDevice(deviceId: string): Promise<any>

  Sets current audio output device.

  Parameters

  • deviceId: string

    Id of 'audiooutput' device from navigator.mediaDevices.enumerateDevices().

  Returns Promise<any>

  resolves when audio output is changed, is rejected otherwise

StaticstopMediaStream

• stopMediaStream(mediaStream: MediaStream): void

  A method to handle stopping of the stream. One point to handle the differences in various implementations.

  Parameters

  • mediaStream: MediaStream

    MediaStream object to stop.

  Returns void