lib-jitsi-meet
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _channel: BridgeChannel
    _channelOpenListener: () => void
    _forwardedSourcesChangeListener: any
    _receiverVideoConstraints: any
    conference: any
    localTracks: any[]
    options: {}
    peerConnections: Map<number, TraceablePeerConnection>

    A map of active TraceablePeerConnection.

    options: {}

    Methods

    • Removed given peer connection from this RTC module instance.

      Parameters

      Returns boolean

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

    • Closes the currently opened bridge channel.

      Returns void

    • 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

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

      Returns void

    • Returns the endpoint id for the local user.

      Returns string

    • 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[]

    • 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[]

    • 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

    • 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.

    • Returns the number of listeners for the specified event.

      Parameters

      • OptionaleventName: string

        The name of the event.

      Returns number

      • The number of listeners for the event.
    • Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.

      Parameters

      • eventId: string

        The event ID.

      • handler: EventListener

        Handler for the event.

      Returns void

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

      Returns 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

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

    • Sends the local stats via the bridge channel.

      Parameters

      • payload: any

        The payload of the message.

      Returns void

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

    • Sends a receiver audio subscription message.

      Parameters

      • message: any

      Returns 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

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

      Returns Promise<any>

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

      Returns Promise<any>

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

      Parameters

      • maxFps: number

        framerate to be used for desktop track capture.

      Returns 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

    • 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

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

      Returns Promise<any>

    • Parameters

      • eventType: any
      • listener: any

      Returns void

    • Parameters

      • elSelector: any
      • stream: any

      Returns any

    • Allows to receive list of available cameras/microphones.

      Parameters

      • callback: Function

        Would receive array of devices as an argument.

      Returns void

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

      Returns string

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

      Returns any[]

      list of available media devices.

    • Returns event data for device to be reported to stats.

      Parameters

      • device: any

      Returns MediaDeviceInfo

      device.

    • Returns whether the desktop sharing is enabled or not.

      Returns 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.

    • 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.

    • 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

    • Parameters

      • eventType: any
      • listener: any

      Returns void

    • 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

    • 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