lib-jitsi-meet
    Preparing search index...

    Class JitsiParticipant

    Represents a participant in (i.e. a member of) a conference.

    Index

    Constructors

    constructor

    Methods

    _setSources getBotType getConference getConnectionJid getDisplayName getFeatures getId getIdentity getJid getProperty getRole getSources getStatsID getStatus getTracks getTracksByMediaType hasFeature isAudioMuted isHidden isHiddenFromRecorder isModerator isReplaced isReplacing isSilent isVideoMuted setBotType setConnectionJid setFeatures setIsReplaced setIsReplacing setIsSilent setProperty setRole supportsDTMF

    Constructors

    • Initializes a new JitsiParticipant instance.

      Parameters

      • jid: string

        the conference XMPP jid

      • conference: JitsiConference
      • displayName: string
      • hidden: boolean

        True if the new JitsiParticipant instance is to represent a hidden participant; otherwise, false.

      • OptionalstatsID: string

        optional participant statsID

      • Optionalstatus: string

        the initial status if any.

      • Optionalidentity: object

        the xmpp identity

      • OptionalisReplacing: boolean

        whether this is a participant replacing another into the meeting.

      • OptionalisReplaced: boolean

        whether this is a participant to be kicked and replaced into the meeting.

      • OptionalisSilent: boolean

        whether participant has joined without audio

      Returns JitsiParticipant

    Methods

    _setSources

    • _setSources(
          mediaType: MediaType,
          muted: boolean,
          sourceName: string,
          videoType: VideoType,
      ): void

      Sets source info.

      Parameters

      • mediaType: MediaType

        The media type, 'audio' or 'video'.

      • muted: boolean

        The new muted state.

      • sourceName: string

        The name of the source.

      • videoType: VideoType

        The video type of the source.

      Returns void

    • Returns the bot type for the participant.

      Returns string

      • The bot type of the participant.

    • Returns the connection jid for the participant.

      Returns string

      • The connection jid of the participant.

    • Returns string

      The human-readable display name of this participant.

    • Returns a set with the features for the participant.

      Returns Promise<Set<string>>

    • Returns the XMPP identity. This is defined by your application in the JWT context claims section.

      Returns object

      • XMPP user identity.

    • Gets the value of a property of this participant.

      Parameters

      • name: string

      Returns any

    • Checks current set features.

      Parameters

      • feature: string

        the feature to check.

      Returns boolean

      true if this participant contains the feature.

    • Returns boolean

      Whether this participant has muted their audio.

    • Returns boolean

      Whether this participant is a hidden participant. Some special system participants may want to join hidden (like for example the recorder).

    • Returns boolean

      Whether this participant is a hidden participant. Some special system participants may want to join hidden (like for example the recorder).

    • Returns boolean

      Whether this participant is a moderator or not.

    • Returns boolean

      Wheter this participants will be replaced by another participant in the meeting.

    • Returns boolean

      Whether this participant replaces another participant from the meeting.

    • Returns boolean

      Whether this participant has joined without audio.

    • Returns boolean

      Whether this participant has muted their video.

    • Sets the bot type for the participant.

      Parameters

      • newBotType: string

        The new bot type to set.

      Returns void

    • Sets the connection jid for the participant.

      Parameters

      • newJid: string

        The connection jid to set.

      Returns void

    • Set new features.

      Parameters

      • OptionalnewFeatures: Set<string>

        Sets new features.

      Returns void

    • Sets whether participant is being replaced by another based on jwt.

      Parameters

      • newIsReplaced: boolean

        whether is being replaced.

      Returns void

    • Sets whether participant is replacing another based on jwt.

      Parameters

      • newIsReplacing: boolean

        whether is replacing.

      Returns void

    • Sets whether participant has joined without audio.

      Parameters

      • newIsSilent: boolean

        whether is silent.

      Returns void

    • Sets the value of a property of this participant, and fires an event if the value has changed.

      Parameters

      • name: string

        the name of the property.

      • value: any

        the value to set.

      Returns void

    • Sets a new participant role.

      Parameters

      • newRole: string

        the new role.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods