RemoteParticipant

Defined in: client-sdk-js/src/participant/RemoteParticipant.ts:29

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

Participant<RemoteTrackPublication>

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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E] : (…args) => void

Returns

this

Inherited from

Participant.addListener

attributes

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

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

Inherited from

Participant.attributes

audioLevel

audioLevel: number = 0;

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

Inherited from

Participant.audioLevel

audioTrackPublications

audioTrackPublications: Map<string, RemoteTrackPublication>;

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

Inherited from

Participant.audioTrackPublications

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<RemoteTrackPublication>[E]>

Returns

boolean

Inherited from

Participant.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.

Inherited from

Participant.groupId

identity

identity: string;

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

Inherited from

Participant.identity

isSpeaking

isSpeaking: boolean = false;

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

Inherited from

Participant.isSpeaking

joinedAt?

joinedAt?: Date;

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

Inherited from

Participant.joinedAt

lastSpokeAt?

lastSpokeAt?: Date;

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

Inherited from

Participant.lastSpokeAt

listenerCount

listenerCount: (event) => number;

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

Parameters

event

string | number

Returns

number

Inherited from

Participant.listenerCount

listeners

listeners: <E>(event) => E extends keyof ParticipantEvents<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E][] : ((…args) => void)[]

Inherited from

Participant.listeners

metadata?

metadata?: string;

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

Inherited from

Participant.metadata

name?

name?: string;

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

Inherited from

Participant.name

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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E] : (…args) => void

Returns

this

Inherited from

Participant.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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E] : (…args) => void

Returns

this

Inherited from

Participant.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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E] : (…args) => void

Returns

this

Inherited from

Participant.once

permissions?

permissions?: ParticipantPermission;

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

Inherited from

Participant.permissions

rawListeners

rawListeners: <E>(event) => E extends keyof ParticipantEvents<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E][] : ((…args) => void)[]

Inherited from

Participant.rawListeners

removeAllListeners

removeAllListeners: (event?) => this;

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

Parameters

event?

string | number

Returns

this

Inherited from

Participant.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<RemoteTrackPublication> ? ParticipantEvents<RemoteTrackPublication>[E] : (…args) => void

Returns

this

Inherited from

Participant.removeListener

sid

sid: string;

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

Inherited from

Participant.sid

state

state: ParticipantState;

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

Inherited from

Participant.state

trackPublications

trackPublications: Map<string, RemoteTrackPublication>;

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

Inherited from

Participant.trackPublications

videoTrackPublications

videoTrackPublications: Map<string, RemoteTrackPublication>;

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

Inherited from

Participant.videoTrackPublications

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

Participant.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

Inherited from

Participant.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

Inherited from

Participant.isActive

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

Inherited from

Participant.isAgent

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

Inherited from

Participant.isCameraEnabled

isLocal

Get Signature

get isLocal(): boolean;

Defined in: client-sdk-js/src/participant/RemoteParticipant.ts:53

Returns

boolean

Overrides

Participant.isLocal

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

Inherited from

Participant.isMicrophoneEnabled

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

Inherited from

Participant.isScreenShareEnabled

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

Inherited from

Participant.kind

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

Participant.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

Participant.getMaxListeners

getTrackPublication()

getTrackPublication(source): RemoteTrackPublication | undefined;

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

Parameters

getTrackPublicationByName()

getTrackPublicationByName(name): RemoteTrackPublication | undefined;

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

Find a track publication by its name.

Parameters

name

string

Returns

RemoteTrackPublication | undefined

Inherited from

Participant.getTrackPublicationByName

getTrackPublications()

getTrackPublications(): RemoteTrackPublication[];

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

Returns all track publications as an array.

Returns

RemoteTrackPublication[]

Inherited from

Participant.getTrackPublications

getVolume()

getVolume(): number;

Defined in: client-sdk-js/src/participant/RemoteParticipant.ts:88

Get the current output volume for this participant’s audio tracks. Returns the volume of the first audio track, or 1 if none.

Returns

number

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

Participant.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

Participant.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

Participant.setMaxListeners

setVolume()

setVolume(volume): void;

Defined in: client-sdk-js/src/participant/RemoteParticipant.ts:77

Set the output volume for all audio tracks from this participant.

Parameters

volume

number

Value between 0 and 1.

Returns

void

updateFromInfo()

updateFromInfo(info): void;

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

Parameters

info

ParticipantInfo

Returns

void

Inherited from

Participant.updateFromInfo

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>

Inherited from

Participant.waitUntilActive

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

Participant.listenerCount