Class: LocalParticipant

The local half. Every method that can fail returns a promise that rejects with a TalklineError — no booleans, no silent no-ops.

Constructors

Constructor

new LocalParticipant(ctx): LocalParticipant;

Parameters

Parameter	Type
ctx	LocalParticipantContext

Returns

LocalParticipant

Accessors

grants

Get Signature

get grants(): Grants | null;

What the server actually granted, which may be narrower than the token asked for. Render capabilities from these and never from what was requested — a UI built on the request shows buttons the server will refuse.

Returns

Grants | null

---

identity

Get Signature

get identity(): string;

Returns

string

---

info

Get Signature

get info(): ParticipantInfo | null;

Returns

ParticipantInfo | null

---

isCameraEnabled

Get Signature

get isCameraEnabled(): boolean;

Returns

boolean

---

isMicrophoneEnabled

Get Signature

get isMicrophoneEnabled(): boolean;

Returns

boolean

---

isScreenShareEnabled

Get Signature

get isScreenShareEnabled(): boolean;

Returns

boolean

---

selectedAudioInput

Get Signature

get selectedAudioInput(): string | undefined;

Returns

string | undefined

---

selectedVideoInput

Get Signature

get selectedVideoInput(): string | undefined;

Returns

string | undefined

---

tracks

Get Signature

get tracks(): Track[];

Returns

Track[]

Methods

enableCamera()

enableCamera(constraints?): Promise<Track>;

Parameters

Parameter	Type
constraints	MediaTrackConstraints

Returns

Promise<Track>

---

enableMicrophone()

enableMicrophone(constraints?): Promise<Track>;

Parameters

Parameter	Type
constraints	MediaTrackConstraints

Returns

Promise<Track>

---

setAudioInput()

setAudioInput(deviceId): Promise<void>;

A device swap, invisible to the far side: replaceTrack keeps the sender and the m-line, so nothing renegotiates and no tile blinks.

Parameters

Parameter	Type
deviceId	string

Returns

Promise<void>

---

setCameraEnabled()

setCameraEnabled(enabled): Promise<void>;

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<void>

---

setMicrophoneEnabled()

setMicrophoneEnabled(enabled): Promise<void>;

Mute or unmute. Muting stops the microphone's packets at this end, rather than hiding them at the far end; the track stays published and comes back at once.

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<void>

---

setScreenShareEnabled()

setScreenShareEnabled(enabled): Promise<Track | null>;

Parameters

Parameter	Type
enabled	boolean

Returns

Promise<Track | null>

---

setVideoInput()

setVideoInput(deviceId): Promise<void>;

Parameters

Parameter	Type
deviceId	string

Returns

Promise<void>