Variable JitsiMeetJSConst

Type declaration

• analytics: unknown

  Analytics configuration.

• constants: {
      recording: IRecordingConstants;
      sipVideoGW: __module;
      trackStreamingStatus: typeof TrackStreamingStatus;
      transcriptionStatus: __module;
  }

  Constants used throughout the library.

• errors: {
      conference: JitsiConferenceErrors;
      connection: JitsiConnectionErrors;
      track: JitsiTrackErrors;
  }

• errorTypes: { JitsiTrackError: typeof JitsiTrackError }

• events: {
      conference: JitsiConferenceEvents;
      connection: typeof JitsiConnectionEvents;
      connectionQuality: __module;
      detection: __module;
      e2eping: __module;
      mediaDevices: JitsiMediaDevicesEvents;
      rtcstats: __module;
      track: JitsiTrackEvents;
  }

• JitsiConnection: typeof JitsiConnection

• logLevels: any

• mediaDevices: JitsiMediaDevices

• ProxyConnectionService: typeof default

  ProxyConnectionService is used to connect a remote peer to a local Jitsi participant without going through a Jitsi conference. It is currently used for room integration development, specifically wireless screensharing. Its API is experimental and will likely change; usage of it is advised against.

• rtcstats: {
      isTraceAvailable(): boolean;
      on(event: any, handler: any): void;
      sendIdentityEntry(identityData: any): void;
      sendStatsEntry(statsType: any, data: any): void;
  }

  Expose rtcstats to the public API.

  • isTraceAvailable: function

    • isTraceAvailable(): boolean

      Checks if the rtcstats trace is available. The trace is the abstraction for the underlying rtcstats websocket connection.

      Returns boolean

      true if the rtcstats trace is available or false otherwise.

  • on: function

    • on(event: any, handler: any): void

      Events generated by rtcstats, such as PeerConnections state, and websocket connection state.

      Parameters

      • event: any

        The event name.
      • handler: any

        The event handler.

      Returns void

  • sendIdentityEntry: function

    • sendIdentityEntry(identityData: any): void

      Sends identity data to the rtcstats server. This data is used to identify the specifics of a particular client, it can be any object and will show in the generated rtcstats dump under "identity" entries.

      Parameters

      • identityData: any

        Identity data to send.

      Returns void

  • sendStatsEntry: function

    • sendStatsEntry(statsType: any, data: any): void

      Sends a stats entry to rtcstats server.

      Parameters

      • statsType: any

        The type of stats to send.
      • data: any

        The stats data to send.

      Returns void

• util: {
      browser: BrowserCapabilities;
      ScriptUtil: { loadScript(options: ILoadScriptOptions): void };
  }

  Represents a hub/namespace for utility functionality which may be of interest to lib-jitsi-meet clients.

  • browser: BrowserCapabilities

  • ScriptUtil: { loadScript(options: ILoadScriptOptions): void }

    • loadScript: function

      • loadScript(options: ILoadScriptOptions): void

        Loads a script from a specific source.

        Parameters

        • options: ILoadScriptOptions

          • src

            the source from the which the script is to be (down)loaded

          • async

            true to asynchronously load the script or false to synchronously load the script

          • prepend

            true to schedule the loading of the script as soon as possible or false to schedule the loading of the script at the end of the scripts known at the time

          • relativeURL

            whether we need load the library from url relative to the url that lib-jitsi-meet was loaded. Useful when sourcing the library from different location than the app that is using it

          • loadCallback

            on load callback function

          • errorCallback

            callback to be called on error loading the script

        Returns void

• version: string

• addGlobalLogTransport: function

  • addGlobalLogTransport(globalTransport: any): void

    Registers new global logger transport to the library logging framework.

    Parameters

    • globalTransport: any

    Returns void

    See

    Logger.addGlobalTransport

• createAudioMixer: function

  • createAudioMixer(): AudioMixer

    Create AudioMixer, which is essentially a wrapper over web audio ChannelMergerNode. It essentially allows the user to mix multiple MediaStreams into a single one.

    Returns AudioMixer

• createLocalTracks: function

  • createLocalTracks(options?: ICreateLocalTrackOptions): any

    Creates local media tracks.

    Parameters

    • options: ICreateLocalTrackOptions = {}

      Object with properties / settings specifying the tracks which should be created. should be created or some additional configurations about resolution for example.

      • effects

        optional effects array for the track

      • devices

        the devices that will be requested

      • resolution

        resolution constraints

      • cameraDeviceId

      • micDeviceId

    Returns any

    A promise that returns an array of created JitsiTracks if resolved, or a JitsiConferenceError if rejected.

• createLocalTracksFromMediaStreams: function

  • createLocalTracksFromMediaStreams(
        tracksInfo: ICreateLocalTrackFromMediaStreamOptions[],
    ): JitsiLocalTrack[]

    Manually create JitsiLocalTrack's from the provided track info, by exposing the RTC method

    Parameters

    • tracksInfo: ICreateLocalTrackFromMediaStreamOptions[]

      array of track information

    Returns JitsiLocalTrack[]

    • created local tracks

• createTrackVADEmitter: function

  • createTrackVADEmitter(
        localAudioDeviceId: any,
        sampleRate: any,
        vadProcessor: any,
    ): Promise<TrackVADEmitter>

    Create a TrackVADEmitter service that connects an audio track to an VAD (voice activity detection) processor in order to obtain VAD scores for individual PCM audio samples.

    Parameters

    • localAudioDeviceId: any

      The target local audio device.
    • sampleRate: any

      Sample rate at which the emitter will operate. Possible values 256, 512, 1024, 4096, 8192, 16384. Passing other values will default to closes neighbor. I.e. Providing a value of 4096 means that the emitter will process 4096 PCM samples at a time, higher values mean longer calls, lowers values mean more calls but shorter.
    • vadProcessor: any

      VAD Processors that does the actual compute on a PCM sample.The processor needs to implement the following functions:

      • getSampleLength() - Returns the sample size accepted by calculateAudioFrameVAD.
      • getRequiredPCMFrequency() - Returns the PCM frequency at which the processor operates. i.e. (16KHz, 44.1 KHz etc.)
      • calculateAudioFrameVAD(pcmSample) - Process a 32 float pcm sample of getSampleLength size.

    Returns Promise<TrackVADEmitter>

• getActiveAudioDevice: function

  • getActiveAudioDevice(): Promise<IActiveDeviceInfo>

    Go through all audio devices on the system and return one that is active, i.e. has audio signal.

    Returns Promise<IActiveDeviceInfo>

    Promise