lib-jitsi-meet
    Preparing search index...

    Creates a JitsiConference object with the given name and properties. Note: this constructor is not a part of the public API (objects should be created using JitsiConnection.createConference).

    properties / settings related to the conference that will be created.

    the name of the conference

    the JitsiConnection object for this JitsiConference.

    how many samples are to be collected by AvgRTPStatsReporter, before arithmetic mean is calculated and submitted to the analytics module.

    when set to true the peer to peer mode will be enabled. It means that when there are only 2 participants in the conference an attempt to make direct connection will be made. If the connection succeeds the conference will stop sending data through the JVB connection and will use the direct one instead.

    a delay given in seconds, before the conference switches back to P2P, after the 3rd participant has left the room.

    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.

    Index

    Constructors

    Properties

    Methods

    _addLocalTrackToPc _fireAudioLevelChangeEvent _fireMuteChangeEvent _init _removeLocalSourceOnReject _removeLocalTrackFromPc _restartMediaSessions _sendConferenceJoinAnalyticsEvent _setTranscribingEnabled _setupNewTrack _stopJvbSession _updateRoomPresence addCommandListener addEventListener addLobbyMessageListener addTrack authenticateAndUpgradeRole avModerationApprove avModerationReject broadcastEndpointMessage createVideoSIPGWSession dial disableAVModeration disableLobby dispose enableAVModeration enableLobby end getActiveMediaSession getActivePeerConnection getAuthLogin getBreakoutRooms getConnection getConnectionState getConnectionTimes getFileSharing getForwardedSources getLastN getLocalAudioTrack getLocalParticipantProperty getLocalTracks getLocalVideoTrack getLocalVideoTracks getMediaSessions getMeetingUniqueId getMetadataHandler getName getP2PConnectionState getParticipantById getParticipantCount getParticipants getPhoneNumber getPhonePin getProperty getRole getShortTermCredentials getSpeakerStats getSsrcByTrack getStartMutedPolicy getTranscriptionStatus grantOwner hangup isAuthEnabled isAVModerationSupported isCallstatsEnabled isConnectionInterrupted isDTMFSupported isE2EEEnabled isE2EESupported isEndConferenceSupported isFocus isHidden isJoined isLobbySupported isLoggedIn isMembersOnly isModerator isP2PActive isP2PEnabled isP2PTestModeEnabled isSIPCallingSupported isVisitorsSupported join joinLobby kickParticipant leave lobbyApproveAccess lobbyDenyAccess lock markParticipantVerified muteParticipant myLobbyUserId myUserId off on onCallAccepted onCallEnded once onDisplayNameChanged onIncomingCall onLocalRoleChanged onLocalTrackRemoved onMemberJoined onMemberKicked onMemberLeft onRemoteTrackAdded onRemoteTrackRemoved onSilentStatusChanged onTransportInfo onUserRoleChanged removeCommand removeCommandListener removeEventListener removeLobbyMessageHandler removeLocalParticipantProperty removeTrack replaceTrack revokeOwner sendApplicationLog sendCommand sendCommandOnce sendEndpointMessage sendEndpointStatsMessage sendFaceLandmarks sendFeedback sendLobbyMessage sendMessage sendPrivateTextMessage sendReaction sendTextMessage sendTones setAssumedBandwidthBps setDesktopSharingFrameRate setDisplayName setIsSilent setLastN setLocalParticipantProperty setMediaEncryptionKey setReceiverConstraints setReceiverVideoConstraint setSenderVideoConstraint setStartMutedPolicy setSubject setTranscriptionLanguage startP2PSession startRecording startVerification stopP2PSession stopRecording toggleE2EE unlock updateDTMFSupport resourceCreator

    Constructors

    Properties

    _audioAnalyser: VADAudioAnalyser
    _audioSenderLimitReached: any

    Flag set to true when Jicofo sends a presence message indicating that the max audio sender limit has been reached for the call. Once this is set, unmuting audio will be disabled from the client until it gets reset again by Jicofo.

    _delayedIceFailed: IceFailedHandling
    _desktopSharingFrameRate: number
    _e2eEncryption: E2EEncryption
    _firefoxP2pEnabled: any
    _hasVisitors: boolean
    _iceRestarts: number

    Number of times ICE restarts that have been attempted after ICE connectivity with the JVB was lost.

    _liteModeContext: LiteModeContext
    _noAudioSignalDetection: NoAudioSignalDetection
    _numberOfParticipantsOnJoin: number
    _sessionInitiateTimeout: any
    _statsCurrentId: any
    _transcribingEnabled: any
    _videoSenderLimitReached: any

    Flag set to true when Jicofo sends a presence message indicating that the max video sender limit has been reached for the call. Once this is set, unmuting video will be disabled from the client until it gets reset again by Jicofo.

    _visitorCodecs: any
    authEnabled: boolean
    avgRtpStatsReporter: AvgRTPStatsReporter

    Reports average RTP statistics to the analytics module.

    backToP2PDelay: number

    A delay given in seconds, before the conference switches back to P2P after the 3rd participant has left.

    componentsVersions: ComponentsVersions
    connection: any
    connectionQuality: ConnectionQuality

    The object which monitors local and remote connection statistics (e.g. sending bitrate) and calculates a number which represents the connection quality.

    deferredStartP2PTask: number

    Stores reference to deferred start P2P task. It's created when 3rd participant leaves the room in order to avoid ping pong effect (it could be just a page reload).

    dtmfManager: any
    e2eping: E2ePing
    eventEmitter: EventEmitter
    eventManager: JitsiConferenceEventManager
    isJvbConnectionInterrupted: boolean

    Indicates whether the connection is interrupted or not.

    isMutedByFocus: boolean
    isP2PConnectionInterrupted: boolean

    If set to true it means the P2P ICE is no longer connected. When false it means that P2P ICE (media) connection is up and running.

    isVideoMutedByFocus: boolean
    jvb121Status: Jvb121EventGenerator
    jvbEstablishmentDuration: any
    jvbJingleSession: JingleSessionPC

    Jingle session instance for the JVB connection.

    lastDominantSpeaker: any
    mutedByFocusActor: any
    mutedVideoByFocusActor: any
    options: any
    p2p: boolean

    Flag set to true when P2P session has been established (ICE has been connected) and this conference is currently in the peer to peer mode (P2P connection is the active one).

    p2pDominantSpeakerDetection: P2PDominantSpeakerDetection
    p2pEstablishmentDuration: any
    p2pJingleSession: JingleSessionPC

    A JingleSession for the direct peer to peer connection.

    participants: Map<string, default>

    List of all the participants in the conference.

    properties: {}
    qualityController: QualityController
    recordingManager: RecordingManager
    room: any
    rtc: RTC
    somebodySupportsDTMF: boolean
    speakerStatsCollector: SpeakerStatsCollector

    The object which tracks active speaker times

    startMutedPolicy: { audio: boolean; video: boolean }
    statistics: Statistics
    videoSIPGWHandler: VideoSIPGW
    wasStopped: boolean
    xmpp: any

    Methods

    • Method called by the JitsiLocalTrack in order to add the underlying MediaStream to the RTCPeerConnection.

      Parameters

      • track: JitsiLocalTrack

        The local track that will be added to the pc.

      Returns Promise<any>

      Resolved when the process is done or rejected with a string which describes the error.

    • Fires TRACK_AUDIO_LEVEL_CHANGED change conference event (for local tracks).

      Parameters

      • audioLevel: number

        The audio level.

      • Optionaltpc: TraceablePeerConnection

        The peer connection.

      Returns void

    • Fires TRACK_MUTE_CHANGED change conference event.

      Parameters

      • track: JitsiTrack

        The JitsiTrack object related to the event.

      Returns void

    • Initializes the conference object properties

      Parameters

      • options: { connection: JitsiConnection }

        {object}

        • connection: JitsiConnection

          {JitsiConnection} overrides this.connection

      Returns void

    • Handler for when a source-add for a local source is rejected by Jicofo.

      Parameters

      • jingleSession: JingleSessionPC

        The media session.

      • error: Error

        The error message.

      • mediaType: MediaType

        The media type of the track associated with the source that was rejected.

      Returns void

    • Method called by the JitsiLocalTrack in order to remove the underlying MediaStream from the RTCPeerConnection.

      Parameters

      • track: JitsiLocalTrack

        The local track that will be removed.

      Returns Promise<any>

      Resolved when the process is done or rejected with a string which describes the error.

    • Sends a conference.join analytics event.

      Returns void

    • Set the transcribingEnabled flag. When transcribing is enabled, p2p is disabled.

      Parameters

      • enabled: boolean

        Whether transcribing should be enabled.

      Returns void

    • Operations related to creating a new track.

      Parameters

      • newTrack: JitsiLocalTrack

        The new track being created.

      Returns void

    • Stops the current JVB jingle session.

      Parameters

      • options: {
            reason: string;
            reasonDescription: string;
            requestRestart: boolean;
            sendSessionTerminate: boolean;
        } = {}

        options for stopping JVB session.

        • reason: string

          One of the Jingle "reason" element names as defined by https://xmpp.org/extensions/xep-0166.html#def-reason

        • reasonDescription: string

          Text description that will be included in the session terminate message.

        • requestRestart: boolean

          Whether this is due to a session restart, in which case, session will be set to null.

        • sendSessionTerminate: boolean

          Whether session-terminate needs to be sent to Jicofo.

      Returns void

    • Updates room presence if needed and send the packet in case of a modification.

      Parameters

      • jingleSession: JingleSessionPC

        the session firing the event, contains the peer connection which tracks we will check.

      • ctx: any

        a context object we can distinguish multiple calls of the same pass of updating tracks.

      Returns void

    • Receives notifications from other participants about commands / custom events (sent by sendCommand or sendCommandOnce methods).

      Parameters

      • command: string

        The name of the command.

      • handler: Function

        Handler for the command.

      Returns void

    • Alias for on method.

      Parameters

      • eventId: string

        The event ID.

      • handler: Function

        Handler for the event.

      Returns void

    • Adds a message listener to the lobby room

      Parameters

      • listener: Function

        The listener function, called when a new message is received in the lobby room.

      Returns Function

      Handler returned to be able to remove it later.

    • Adds JitsiLocalTrack object to the conference.

      Parameters

      • track: JitsiLocalTrack

        The JitsiLocalTrack object.

      Returns Promise<JitsiLocalTrack>

      If the specified track is a video track and there is already another video track in the conference.

    • Authenticates and upgrades the role of the local participant/user.

      Parameters

      • options: any

        Configuration options for authentication.

      Returns any

      A thenable which (1) settles when the process of authenticating and upgrading the role of the local participant/user finishes and (2) has a cancel method that allows the caller to interrupt the process.

    • Approve participant access to certain media, allows unmuting audio or video.

      Parameters

      • mediaType: MediaType

        "audio" or "video"

      • id: any

        the id of the participant.

      Returns void

    • Reject participant access to certain media, blocks unmuting audio or video.

      Parameters

      • mediaType: MediaType

        "audio" or "video"

      • id: any

        the id of the participant.

      Returns void

    • Sends a broadcast message via the data channel.

      Parameters

      • payload: any

        The payload of the message.

      Returns void

      If the operation fails.

      Use 'sendMessage' instead. TODO: this should be private.

    • Creates a video SIP GW session and returns it if service is enabled. Before creating a session one need to check whether video SIP GW service is available in the system JitsiConference.isVideoSIPGWAvailable. Even if there are available nodes to serve this request, after creating the session those nodes can be taken and the request about using the created session can fail.

      Parameters

      • sipAddress: string

        The sip address to be used.

      • displayName: string

        The display name to be used for this session.

      Returns any

      Returns null if conference is not initialised and there is no room.

    • Dials a phone number to join the conference.

      Parameters

      • number: string

        The phone number to dial.

      Returns Promise<any>

      Resolves when the dial is successful, rejects otherwise.

    • Disables AV Moderation.

      Parameters

      • mediaType: MediaType

        "audio" or "video"

      Returns void

    • Disposes of conference resources. This operation is a short-hand for leaving the conference and disconnecting the connection.

      Returns Promise<any>

    • Enables AV Moderation.

      Parameters

      • mediaType: MediaType

        "audio" or "video"

      Returns void

    • Enables lobby by moderators

      Returns Promise<any>

      resolves when lobby room is joined or rejects with the error.

    • Returns the currently active media session if any.

      Returns any

    • Returns the active peer connection (P2P or JVB).

      Returns any

      The active peer connection or null if none is available.

    • Returns the breakout rooms manager object.

      Returns any

      the breakout rooms manager.

    • Returns the connection state for the current room. NOTE that "completed" ICE state which can appear on the P2P connection will be converted to "connected".

      Returns string

      The ICE connection state or null if no active peer connection exists.

    • Returns measured connection times.

      Returns any

      The connection times for the room.

    • Returns the file sharing manager object.

      Returns any

      the file sharing manager.

    • Obtains the forwarded sources list in this conference.

      Returns string[]

    • Gets a local participant property.

      Parameters

      • name: string

        The name of the property to retrieve.

      Returns string

      The value of the property if it exists, otherwise undefined.

    • 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 (audio or video).

      Returns JitsiLocalTrack[]

    • Returns all the local video tracks.

      Returns JitsiLocalTrack[]

    • Returns an array containing all media sessions existing in this conference.

      Returns JingleSessionPC[]

    • Returns the meeting unique ID if any.

      Returns string

      The meeting ID or undefined if not available.

    • Returns the metadata handler object.

      Returns any

      the room metadata handler.

    • Returns the current ICE state of the P2P connection. NOTE: method is used by the jitsi-meet-torture tests.

      Returns string

      an ICE state or null if there's currently no P2P connection.

    • Parameters

      • id: any

        the id of the participant.

      Returns default

      the participant in this conference with the specified id (or undefined if there isn't one).

    • Returns the number of participants in the conference, including the local participant.

      Parameters

      • countHidden: boolean = false

        {boolean} Whether or not to include hidden participants in the count. Default: false.

      Returns number

    • Returns the phone number for joining the conference.

      Returns string

      The phone number or null if not available.

    • Returns the PIN for joining the conference via phone.

      Returns string

      The phone PIN or null if not available.

    • Gets a conference property with a given key.

      Parameters

      • key: string

        The key.

      Returns any

      The value

    • Get role of the local user.

      Returns string

      User role: 'moderator' or 'none'.

    • Requests short-term credentials from the backend if available.

      Parameters

      • service: string

        The service for which to request the credentials.

      Returns Promise<any>

      A promise that resolves with the credentials or rejects with an error.

    • Get a summary of how long current participants have been the dominant speaker

      Returns any

      The speaker statistics.

    • Finds the SSRC of a given track.

      Parameters

      • track: JitsiTrack

        The track to find the SSRC for.

      Returns number

      The SSRC of the specified track, or undefined if not found.

    • Returns the current start muted policy.

      Returns any

      Object with audio and video properties indicating the start muted policy.

    • Returns the transcription status.

      Returns string

      "on" or "off".

    • Grant owner rights to the participant.

      Parameters

      • id: string

        id of the participant to grant owner rights to.

      Returns void

    • Hangs up an existing call.

      Returns Promise<any>

      Resolves when the hangup is successful.

    • Check if authentication is enabled for this conference.

      Returns boolean

    • Returns true if AV Moderation support is enabled in the backend.

      Returns boolean

      whether AV Moderation is supported in the backend.

    • Checks if callstats is enabled.

      Returns boolean

      Always returns false since callstats is no longer supported.

    • Checks if the connection is interrupted.

      Returns boolean

      True if the connection is interrupted, false otherwise.

    • Allows to check if there is at least one user in the conference that supports DTMF.

      Returns boolean

      True if somebody supports DTMF, false otherwise.

    • Returns whether End-To-End encryption is enabled.

      Returns boolean

    • Returns whether End-To-End encryption is supported. Note that not all participants in the conference may support it.

      Returns boolean

    • Returns true if end conference support is enabled in the backend.

      Returns boolean

      whether end conference is supported in the backend.

    • Checks if the user identified by given MUC JID is the conference focus.

      Parameters

      • mucJid: string

        The full MUC address of the user to check.

      Returns boolean

      True if the user is the conference focus, false if not, null if not in MUC or invalid JID.

    • Returns whether or not the current conference has been joined as a hidden user.

      Returns boolean

      True if hidden, false otherwise. Will return null if no connection is active.

    • Check if joined to the conference.

      Returns boolean

      True if joined, false otherwise.

    • Returns true if lobby support is enabled in the backend.

      Returns boolean

      whether lobby is supported in the backend.

    • Returns true if the room has members only enabled.

      Returns boolean

      whether conference room is members only.

    • Check if local user is moderator.

      Returns boolean

      true if local user is moderator, false otherwise. If we're no longer in the conference room then null is returned.

    • Checks whether or not the conference is currently in the peer to peer mode. Being in peer to peer mode means that the direct connection has been established and the P2P connection is being used for media transmission.

      Returns boolean

      true if in P2P mode or false otherwise.

    • Tells whether or not the P2P mode is enabled in the configuration.

      Returns boolean

      True if P2P is enabled, false otherwise.

    • When in P2P test mode, the conference will not automatically switch to P2P when there are 2 participants.

      Returns boolean

      True if P2P test mode is enabled, false otherwise.

    • Returns true if SIP calls are supported, false otherwise.

      Returns boolean

      True if SIP calling is supported, false otherwise.

    • Returns true if the room supports visitors feature.

      Returns boolean

      whether conference room has visitors support.

    • Joins the conference.

      Parameters

      • password: string = ''

        {string} the password

      • replaceParticipant: boolean = false

        {boolean} whether the current join replaces an existing participant with same jwt from the meeting.

      Returns void

    • Joins the lobby room with display name and optional email or with a shared password to skip waiting.

      Parameters

      • displayName: string

        Display name should be set to show it to moderators.

      • email: string

        Optional email is used to present avatar to the moderator.

      Returns Promise<never>

    • Kick participant from this conference.

      Parameters

      • id: string

        id of the participant to kick

      • reason: string

        reason of the participant to kick

      Returns void

    • Leaves the conference.

      Parameters

      • reason: string

        The reason for leaving the conference.

      Returns Promise<any>

    • Approves the request to join the conference to a participant waiting in the lobby.

      Parameters

      • param: string | string[]

        The participant id or an array of ids.

      Returns void

    • Denies an occupant in the lobby room access to the conference.

      Parameters

      • id: string

        The participant id.

      Returns void

    • Set password for the room.

      Parameters

      • password: string

        new password for the room.

      Returns Promise<any>

    • Marks the given participant as verified. After this is done, MAC verification will be performed and an event will be emitted with the result.

      Parameters

      • participantId: string

        The participant which will be marked as verified.

      • isVerified: boolean

        whether the verification was succesfull.

      Returns void

    • Mutes a participant.

      Parameters

      • id: string

        The id of the participant to mute.

      • mediaType: any

      Returns void

    • Gets the local id for a participant in a lobby room. Returns undefined when current participant is not in the lobby room. This is used for lobby room private chat messages.

      Returns string

    • Returns the local user's ID.

      Returns string

      Local user's ID or null if not available.

    • Removes event listener.

      Parameters

      • eventId: string

        The event ID.

      • Optionalhandler: Function

        Optional, the specific handler to unbind.

      Returns void

    • 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: Function

        Handler for the event.

      Returns void

    • Callback called by the Jingle plugin when 'session-answer' is received.

      Parameters

      • session: JingleSessionPC

        The Jingle session for which an answer was received.

      • answer: any

        An element pointing to 'jingle' IQ element.

      Returns void

    • Handles the call ended event. XXX is this due to the remote side terminating the Jingle session?

      Parameters

      • jingleSession: JingleSessionPC

        The Jingle session which has been terminated.

      • reasonCondition: string

        The Jingle reason condition.

      • reasonText: string

        Human readable reason text which may provide more details about why the call has been terminated.

      Returns void

    • Adds a one-time listener function for the event.

      Parameters

      • eventId: string

        The event ID.

      • handler: Function

        Handler for the event.

      Returns void

    • Handles updates to a participant's display name.

      Parameters

      • jid: string

        The Jabber ID (JID) of the participant whose display name changed.

      • displayName: string

        The new display name for the participant.

      Returns void

    • Handles an incoming call event.

      Parameters

      • jingleSession: JingleSessionPC

        The Jingle session for the incoming call.

      • jingleOffer: any

        An element pointing to 'jingle' IQ element containing the offer.

      • now: number

        The timestamp when the call was received.

      Returns void

    • Method called on local MUC role change.

      Parameters

      • role: string

        the name of new user's role as defined by XMPP MUC.

      Returns void

    • Clear JitsiLocalTrack properties and listeners.

      Parameters

      • track: JitsiLocalTrack

        The JitsiLocalTrack object.

      Returns void

    • Notifies this JitsiConference that a new member has joined its chat room.

      FIXME This should NOT be exposed!

      Parameters

      • jid: any

        the jid of the participant in the MUC

      • nick: any

        the display name of the participant

      • role: any

        the role of the participant in the MUC

      • isHidden: any

        indicates if this is a hidden participant (system participant for example a recorder).

      • statsID: any

        the participant statsID (optional)

      • status: any

        the initial status if any

      • identity: any

        the member identity, if any

      • botType: any

        the member botType, if any

      • fullJid: any

        the member full jid, if any

      • features: any

        the member botType, if any

      • isReplaceParticipant: any

        whether this join replaces a participant with the same jwt.

      Returns void

    • Designates an event indicating that we were kicked from the XMPP MUC.

      Parameters

      • isSelfPresence: boolean

        whether it is for local participant or another participant.

      • actorId: string

        the id of the participant who was initiator of the kick.

      • kickedParticipantId: string

        when it is not a kick for local participant, this is the id of the participant which was kicked.

      • reason: string

        reason of the participant to kick

      • isReplaceParticipant: boolean

        whether this is a server initiated kick in order to replace it with a participant with same jwt.

      Returns void

    • Handles the logic when a remote participant leaves the conference.

      Parameters

      • jid: string

        The Jabber ID (JID) of the participant who left.

      • Optionalreason: string

        Optional reason provided for the participant leaving.

      Returns void

    • Notifies this JitsiConference that a JitsiRemoteTrack was added to the conference.

      Parameters

      • track: JitsiRemoteTrack

        the JitsiRemoteTrack which was added to this JitsiConference.

      Returns void

    • Notifies this JitsiConference that a JitsiRemoteTrack was removed from the conference.

      Parameters

      • removedTrack: JitsiRemoteTrack

        The track that was removed.

      Returns void

    • Handles changes to a participant's silent status.

      Parameters

      • jid: string

        The Jabber ID (JID) of the participant whose silent status has changed.

      • isSilent: boolean

        The new silent status of the participant (true if silent, false otherwise).

      Returns void

    • Callback called by the Jingle plugin when 'transport-info' is received.

      Parameters

      • session: JingleSessionPC

        The Jingle session for which the IQ was received.

      • transportInfo: any

        An element pointing to 'jingle' IQ element.

      Returns void

    • Handles changes to a user's role within the conference.

      Parameters

      • jid: string

        The Jabber ID (JID) of the user whose role has changed.

      • role: string

        The new role assigned to the user (e.g., 'moderator', 'participant').

      Returns void

    • Removes presence command.

      Parameters

      • name: string

        The name of the command.

      Returns void

    • Removes command listener.

      Parameters

      • command: string

        The name of the command.

      • handler: Function

        Handler to remove for the command.

      Returns void

    • Alias for off method.

      Parameters

      • eventId: string

        The event ID.

      • Optionalhandler: Function

        Optional, the specific handler to unbind.

      Returns void

    • Removes a message handler from the lobby room

      Parameters

      • handler: Function

        The handler function to remove.

      Returns void

    • Removes a property for the local participant and sends the updated presence.

      Parameters

      • name: string

        The name of the property to remove.

      Returns void

    • Removes JitsiLocalTrack from the conference and performs a new offer/answer cycle.

      Parameters

      • track: JitsiLocalTrack

        The track to remove.

      Returns Promise<any>

    • Replaces oldTrack with newTrack and performs a single offer/answer cycle after both operations are done. Either oldTrack or newTrack can be null; replacing a valid 'oldTrack' with a null 'newTrack' effectively just removes 'oldTrack'

      Parameters

      • oldTrack: JitsiLocalTrack

        The current stream in use to be replaced.

      • newTrack: JitsiLocalTrack

        The new stream to use.

      Returns Promise<any>

      Resolves when the replacement is finished.

    • Revoke owner rights to the participant or local Participant as the user might want to refuse to be a moderator.

      Parameters

      • id: string

        id of the participant to revoke owner rights to.

      Returns void

    • Sends an application log (no-op since callstats is no longer supported).

      Returns void

    • Send presence command.

      Parameters

      • name: string

        The name of the command.

      • values: any

        With keys and values that will be sent.

      Returns void

    • Send presence command one time.

      Parameters

      • name: string

        The name of the command.

      • values: any

        With keys and values that will be sent.

      Returns void

    • Sends a message via the data channel.

      Parameters

      • to: string

        The ID of the endpoint to receive the message, or empty string to broadcast.

      • payload: any

        The payload of the message.

      Returns void

      If the operation fails.

      Use 'sendMessage' instead. TODO: this should be private.

    • Sends local stats via the bridge channel to other endpoints selectively.

      Parameters

      • payload: any

        The payload of the message.

      Returns void

      If the operation fails or no data channel exists.

    • Sends a face landmarks object to the xmpp server.

      Parameters

      • payload: any

        The face landmarks data to send.

      Returns void

    • Sends feedback if enabled.

      Parameters

      • overallFeedback: number

        An integer between 1 and 5 indicating user feedback.

      • detailedFeedback: string

        Detailed feedback from the user (not yet used).

      Returns Promise<any>

      Resolves if feedback is submitted successfully.

    • Sends a message to a lobby room. When id is specified it sends a private message. Otherwise it sends the message to all moderators.

      Parameters

      • message: any
      • id: string

        The participant id.

      Returns void

    • Sends a message to a given endpoint or broadcasts it to all endpoints.

      Parameters

      • message: any

        The message to send (string for chat, object for JSON).

      • Optionalto: string = ''

        The ID of the recipient endpoint, or empty string to broadcast.

      • OptionalsendThroughVideobridge: boolean = false

        Whether to send through jitsi-videobridge.

      Returns void

    • Sends private text message to another participant of the conference.

      Parameters

      • id: string

        The ID of the participant to send a private message.

      • message: string

        The text message.

      • OptionalelementName: string = 'body'

        The element name to encapsulate the message.

      Returns void

      Use 'sendMessage' instead. TODO: this should be private.

    • Sends a reaction to the other participants in the conference.

      Parameters

      • reaction: string

        The reaction.

      • messageId: string

        The ID of the message to attach the reaction to.

      • receiverId: string

        The intended recipient, if the message is private.

      Returns void

    • Sends text message to the other participants in the conference.

      Parameters

      • message: string

        The text message.

      • OptionalelementName: string = 'body'

        The element name to encapsulate the message.

      Returns void

      Use 'sendMessage' instead. TODO: this should be private.

    • Sends DTMF tones to the active peer connection.

      Parameters

      • tones: string

        The DTMF tones to send.

      • duration: number

        The duration of each tone in milliseconds.

      • pause: number

        The pause duration between tones in milliseconds.

      Returns void

    • Sets the assumed bandwidth bps for the video that is requested from the bridge.

      Parameters

      • assumedBandwidthBps: number

        The bandwidth value expressed in bits per second.

      Returns void

    • Configures the peerconnection so that a given framre rate can be achieved for desktop share.

      Parameters

      • maxFps: number

        The capture framerate to be used for desktop tracks.

      Returns boolean

      true if the operation is successful, false otherwise.

    • Sets the display name for this conference.

      Parameters

      • name: string

        The display name to set.

      Returns void

    • Set join without audio.

      Parameters

      • silent: boolean

        Whether user joined without audio.

      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

      • lastN: any

        the new number of videos the user would like to receive.

      Returns void

      Error or RangeError if the given value is not a number or is smaller than -1.

    • Sets a property for the local participant.

      Parameters

      • name: string

        The name of the property.

      • value: string

        The value of the property.

      Returns void

    • Sets the key and index for End-to-End encryption.

      Parameters

      • keyInfo: any

      Returns void

    • Sets the constraints for the video that is requested from the bridge.

      Parameters

      • videoConstraints: any

        The constraints which are specified in the following format. The message updates the fields that are present and leaves the rest unchanged on the bridge. Therefore, any field that is not applicable anymore should be cleared by passing an empty object or list (whatever is applicable). { 'lastN': 20, 'selectedSources': ['A', 'B', 'C'], 'onStageSources': ['A'], 'defaultConstraints': { 'maxHeight': 180 }, 'constraints': { 'A': { 'maxHeight': 720 } } } Where A, B and C are source-names of the remote tracks that are being requested from the bridge.

      Returns void

    • Sets the maximum video size the local participant should receive from remote participants.

      Parameters

      • maxFrameHeight: number

        the maximum frame height, in pixels, this receiver is willing to receive.

      Returns void

    • Sets the maximum video size the local participant should send to remote participants.

      Parameters

      • maxFrameHeight: number

        The user preferred max frame height.

      Returns Promise<any>

      promise that will be resolved when the operation is successful and rejected otherwise.

    • Sets the start muted policy for new participants.

      Parameters

      • policy: { audio: boolean; video: boolean }

        Object with boolean properties for audio and video muting.

        • audio: boolean

          Whether audio should be muted for new participants.

        • video: boolean

          Whether video should be muted for new participants.

      Returns void

    • Set new subject for this conference. (Available only for moderator)

      Parameters

      • subject: string

        New subject.

      Returns void

    • Sets the transcription language. NB: Unlike init here we don't check for the default value since we want to allow the value to be reset.

      Parameters

      • lang: string

        The new transcription language to be used.

      Returns void

    • Manually starts new P2P session (should be used only in the tests).

      Returns void

    • Starts recording the current conference.

      Parameters

      • options: any

        Configuration for the recording. See Chatroom#startRecording for more info.

      Returns Promise<any>

      Resolves when recording starts successfully, rejects otherwise.

    • Starts the participant verification process.

      Parameters

      • participantId: string

        The participant which will be marked as verified.

      Returns void

    • Manually stops the current P2P session (should be used only in the tests).

      Parameters

      • options: any

        Options for stopping P2P.

      Returns void

    • Stops a recording session.

      Parameters

      • sessionID: string

        The ID of the recording session to stop.

      Returns Promise<any>

      Resolves when recording stops successfully, rejects otherwise.

    • Enables / disables End-to-End encryption.

      Parameters

      • enabled: boolean

        whether to enable E2EE or not.

      Returns void

    • Updates DTMF support based on participants' capabilities.

      Returns void

    • Create a resource for the a jid. We use the room nickname (the resource part of the occupant JID, see XEP-0045) as the endpoint ID in colibri. We require endpoint IDs to be 8 hex digits because in some cases they get serialized into a 32bit field.

      Parameters

      • jid: string

        The id set onto the XMPP connection.

      • isAuthenticatedUser: boolean

        Whether or not the user has connected to the XMPP service with a password.

      Returns string