Participant

Defined in: client-sdk-js/src/participant/Participant.ts:147

A typed wrapper over Node’s EventEmitter.

Extends EventEmitter with declare overrides so that emit, on, off, etc. are type-safe without introducing circular-reference issues that arise when using typed-emitter directly in extends clauses whose event maps reference the class itself.

Runtime behaviour is 100% EventEmitter; this class adds zero runtime code.

Extends

• TypedEmitter<ParticipantEvents<TPublication>>

Extended by

• LocalParticipant
• RemoteParticipant

Type Parameters

TPublication

TPublication extends TrackPublication = TrackPublication

Constructors

Constructor

new Participant<TPublication>(
   sid,
   identity,
   name?,
   metadata?
): Participant<TPublication>;

Defined in: client-sdk-js/src/participant/Participant.ts:178

Parameters

sid

string

identity

string

name?

string

metadata?

string

Returns

Participant<TPublication>

Overrides

TypedEmitter.constructor

Properties

addListener

addListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:37

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.addListener

---

attributes

attributes: Record<string, string> = {};

Defined in: client-sdk-js/src/participant/Participant.ts:157

---

audioLevel

audioLevel: number = 0;

Defined in: client-sdk-js/src/participant/Participant.ts:156

---

audioTrackPublications

audioTrackPublications: Map<string, TPublication>;

Defined in: client-sdk-js/src/participant/Participant.ts:162

---

emit

emit: <E>(event, ...args) => boolean;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:17

Type Parameters

E

E extends ParticipantEvent

Parameters

event

E

args

…Parameters<ParticipantEvents<TPublication>[E]>

Returns

boolean

Inherited from

TypedEmitter.emit

---

groupId?

groupId?: string;

Defined in: client-sdk-js/src/participant/Participant.ts:160

The group (breakout room) this participant is currently in. undefined = main room.

---

identity

identity: string;

Defined in: client-sdk-js/src/participant/Participant.ts:151

---

isSpeaking

isSpeaking: boolean = false;

Defined in: client-sdk-js/src/participant/Participant.ts:155

---

joinedAt?

joinedAt?: Date;

Defined in: client-sdk-js/src/participant/Participant.ts:165

---

lastSpokeAt?

lastSpokeAt?: Date;

Defined in: client-sdk-js/src/participant/Participant.ts:164

---

listenerCount

listenerCount: (event) => number;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:57

Parameters

event

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount

---

listeners

listeners: <E>(event) => E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:49

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.listeners

---

metadata?

metadata?: string;

Defined in: client-sdk-js/src/participant/Participant.ts:153

---

name?

name?: string;

Defined in: client-sdk-js/src/participant/Participant.ts:152

---

off

off: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:32

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.off

---

on

on: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:22

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.on

---

once

once: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:27

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.once

---

permissions?

permissions?: ParticipantPermission;

Defined in: client-sdk-js/src/participant/Participant.ts:158

---

rawListeners

rawListeners: <E>(event) => E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E][] : ((...args) => void)[];

Defined in: client-sdk-js/src/utils/typedEmitter.ts:53

Type Parameters

E

E extends string | number

Parameters

event

E

Returns

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E][] : ((…args) => void)[]

Inherited from

TypedEmitter.rawListeners

---

removeAllListeners

removeAllListeners: (event?) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:47

Parameters

event?

string | number

Returns

this

Inherited from

TypedEmitter.removeAllListeners

---

removeListener

removeListener: <E>(event, listener) => this;

Defined in: client-sdk-js/src/utils/typedEmitter.ts:42

Type Parameters

E

E extends string | number

Parameters

event

E

listener

E extends keyof ParticipantEvents<TPublication> ? ParticipantEvents<TPublication>[E] : (…args) => void

Returns

this

Inherited from

TypedEmitter.removeListener

---

sid

sid: string;

Defined in: client-sdk-js/src/participant/Participant.ts:150

---

state

state: ParticipantState;

Defined in: client-sdk-js/src/participant/Participant.ts:154

---

trackPublications

trackPublications: Map<string, TPublication>;

Defined in: client-sdk-js/src/participant/Participant.ts:161

---

videoTrackPublications

videoTrackPublications: Map<string, TPublication>;

Defined in: client-sdk-js/src/participant/Participant.ts:163

---

defaultMaxListeners

static defaultMaxListeners: number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:5

Inherited from

TypedEmitter.defaultMaxListeners

Accessors

connectionQuality

Get Signature

get connectionQuality(): ConnectionQuality;

Defined in: client-sdk-js/src/participant/Participant.ts:217

Current connection quality for this participant.

Returns

ConnectionQuality

---

isActive

Get Signature

get isActive(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:200

Whether the participant is in an active (joined) state.

Returns

boolean

---

isAgent

Get Signature

get isAgent(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:195

Whether this participant is an AI agent.

Returns

boolean

---

isCameraEnabled

Get Signature

get isCameraEnabled(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:251

Whether the participant has an enabled camera track.

Returns

boolean

---

isLocal

Get Signature

get abstract isLocal(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:187

Returns

boolean

---

isMicrophoneEnabled

Get Signature

get isMicrophoneEnabled(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:256

Whether the participant has an enabled microphone track.

Returns

boolean

---

isScreenShareEnabled

Get Signature

get isScreenShareEnabled(): boolean;

Defined in: client-sdk-js/src/participant/Participant.ts:261

Whether the participant is sharing their screen.

Returns

boolean

---

kind

Get Signature

get kind(): ParticipantKind;

Defined in: client-sdk-js/src/participant/Participant.ts:190

The kind of participant (Standard, Agent, etc.).

Returns

ParticipantKind

Methods

eventNames()

eventNames(): (string | number)[];

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:7

Returns

(string | number)[]

Inherited from

TypedEmitter.eventNames

---

getMaxListeners()

getMaxListeners(): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:9

Returns

number

Inherited from

TypedEmitter.getMaxListeners

---

getTrackPublication()

getTrackPublication(source): TPublication | undefined;

Defined in: client-sdk-js/src/participant/Participant.ts:344

Parameters

source

TrackSource

Returns

TPublication | undefined

---

getTrackPublicationByName()

getTrackPublicationByName(name): TPublication | undefined;

Defined in: client-sdk-js/src/participant/Participant.ts:359

Find a track publication by its name.

Parameters

name

string

Returns

TPublication | undefined

---

getTrackPublications()

getTrackPublications(): TPublication[];

Defined in: client-sdk-js/src/participant/Participant.ts:268

Returns all track publications as an array.

Returns

TPublication[]

---

prependListener()

prependListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:14

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependListener

---

prependOnceListener()

prependOnceListener(type, listener): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:15

Parameters

type

string | number

listener

Listener

Returns

this

Inherited from

TypedEmitter.prependOnceListener

---

setMaxListeners()

setMaxListeners(n): this;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:8

Parameters

n

number

Returns

this

Inherited from

TypedEmitter.setMaxListeners

---

updateFromInfo()

updateFromInfo(info): void;

Defined in: client-sdk-js/src/participant/Participant.ts:272

Parameters

info

ParticipantInfo

Returns

void

---

waitUntilActive()

waitUntilActive(): Promise<void>;

Defined in: client-sdk-js/src/participant/Participant.ts:209

Returns a promise that resolves once the participant is active and ready to receive data messages. Rejects if the participant transitions away from the active state first.

Returns

Promise<void>

---

listenerCount()

static listenerCount(emitter, type): number;

Defined in: client-sdk-js/node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:4

Parameters

emitter

EventEmitter

type

string | number

Returns

number

Inherited from

TypedEmitter.listenerCount