RTKParticipantMap

This is a map of participants, indexed by participant.id (a participant's peer ID). This map emits an event whenever a participant present in the map emits an event. For example, when a participant is added to this map, a participantJoined event is emitted from the map. When a participant object emits an event videoUpdate, the map re-emits that event (provided the participant is present in the map).

• RTKParticipantMap
  • module.exports ⏏
    • new module.exports(logger, [options])
    • .add(participant, [emitEvent])
    • .clear([emitEvent], [removeListeners])
    • .delete(participantId, [emitEvent], [removeListeners])

module.exports ⏏

Kind: Exported class

new module.exports(logger, [options])

Param	Type
logger	Logger
[options]	MapEvents

module.exports.add(participant, [emitEvent])

Kind: instance method of module.exports

Param	Type	Default
participant	T
[emitEvent]	boolean	true

module.exports.clear([emitEvent], [removeListeners])

Kind: instance method of module.exports

Param	Type	Default
[emitEvent]	boolean	true
[removeListeners]	boolean	false

module.exports.delete(participantId, [emitEvent], [removeListeners])

Kind: instance method of module.exports

Param	Type	Default
participantId	string
[emitEvent]	boolean	true
[removeListeners]	boolean	false