EntitiesInterfaces

CallSelfParticipant

View as MarkdownOpen in Claude

Self participant interface with control methods Extends CallParticipant with methods for controlling the local participant

Extends

Properties

screenShareStatus
ScreenShareStatusRequired

Current screen-share status for this participant. See ScreenShareStatus.

screenShareStatus$
Observable<ScreenShareStatus>Required

Observable of current screen-share status for this participant. See ScreenShareStatus.

studioAudio
booleanRequired

Whether studio-audio processing is enabled for this participant.

studioAudio$
Observable<boolean>Required

Observable of whether studio-audio processing is enabled for this participant.

addressId
string | undefinedRequired

User-address ID, if this participant is a known user.

addressId$
Observable<string | undefined>Required

Observable of user-address ID, if this participant is a known user.

audioMuted
booleanRequired

Whether this participant’s audio is muted.

audioMuted$
Observable<boolean | undefined>Required

Observable of whether this participant’s audio is muted.

autoGain
booleanRequired

Whether automatic gain control is enabled on this participant’s microphone.

autoGain$
Observable<boolean | undefined>Required

Observable of whether automatic gain control is enabled on this participant’s microphone.

deaf
booleanRequired

Whether this participant is deafened (does not receive other participants’ audio).

deaf$
Observable<boolean | undefined>Required

Observable of whether this participant is deafened (does not receive other participants’ audio).

denoise
booleanRequired

Whether noise suppression is enabled on this participant’s microphone.

denoise$
Observable<boolean | undefined>Required

Observable of whether noise suppression is enabled on this participant’s microphone.

echoCancellation
booleanRequired

Whether echo cancellation is enabled on this participant’s microphone.

echoCancellation$
Observable<boolean | undefined>Required

Observable of whether echo cancellation is enabled on this participant’s microphone.

handraised
booleanRequired

Whether this participant has their hand raised.

handraised$
Observable<boolean | undefined>Required

Observable of whether this participant has their hand raised.

id
stringRequired

Unique participant ID, assigned by the media server.

inputSensitivity
number | undefinedRequired

Microphone input sensitivity, or undefined if not adjustable.

inputSensitivity$
Observable<number | undefined>Required

Observable of microphone input sensitivity, or undefined if not adjustable.

inputVolume
number | undefinedRequired

Microphone input volume, or undefined if not adjustable.

inputVolume$
Observable<number | undefined>Required

Observable of microphone input volume, or undefined if not adjustable.

isAudience
booleanRequired

Whether this participant is an audience member rather than an active participant.

isTalking
booleanRequired

Whether the media server currently detects voice activity from this participant.

isTalking$
Observable<boolean | undefined>Required

Observable of whether the media server currently detects voice activity from this participant.

lowbitrate
booleanRequired

Whether low-bitrate mode is enabled for this participant.

lowbitrate$
Observable<boolean | undefined>Required

Observable of whether low-bitrate mode is enabled for this participant.

meta
Record<string, unknown> | undefinedRequired

Arbitrary metadata bag for the local participant, if any.

meta$
Observable<Record<string, unknown> | undefined>Required

Observable of the call-level metadata bag.

name
string | undefinedRequired

Display name of this participant.

name$
Observable<string | undefined>Required

Observable of display name of this participant.

nodeId
string | undefinedRequired

ID of the media node hosting this participant.

nodeId$
Observable<string | undefined>Required

Observable of the media node ID currently hosting the call.

noiseSuppression
booleanRequired

Whether noise suppression is enabled on this participant’s microphone.

noiseSuppression$
Observable<boolean | undefined>Required

Observable of whether noise suppression is enabled on this participant’s microphone.

outputVolume
number | undefinedRequired

Speaker output volume for this participant, or undefined if not adjustable.

outputVolume$
Observable<number | undefined>Required

Observable of speaker output volume for this participant, or undefined if not adjustable.

position
LayoutLayer | undefinedRequired

Current layout position of this participant, or undefined if not yet placed. See LayoutLayer.

position$
Observable<LayoutLayer | undefined>Required

Observable of current layout position of this participant, or undefined if not yet placed. See LayoutLayer.

userId
string | undefinedRequired

User ID associated with this participant, if known.

userId$
Observable<string | undefined>Required

Observable of user ID associated with this participant, if known.

type
string | undefinedRequired

Participant type (e.g. member, audience).

type$
Observable<string | undefined>Required

Observable of participant type (e.g. member, audience).

videoMuted
booleanRequired

Whether this participant’s video is muted.

videoMuted$
Observable<boolean | undefined>Required

Observable of whether this participant’s video is muted.

visible
booleanRequired

Whether this participant is currently visible in the layout.

visible$
Observable<boolean | undefined>Required

Observable of whether this participant is currently visible in the layout.

Methods

addAdditionalDevice()

1addAdditionalDevice(options): Promise<void>

Parameters

options
MediaOptionsRequired

Per-operation options (media options, device-select options, or capture override depending on context). See MediaOptions.

Returns

Promise<void>

addAudioInputDevice()

1addAudioInputDevice(options?): Promise<void>

Parameters

options
{ constraints?: MediaTrackConstraints; stream?: MediaStream; }

Per-operation options (media options, device-select options, or capture override depending on context). See MediaTrackConstraints and MediaStream.

Returns

Promise<void>

addInputDevices()

1addInputDevices(options?): Promise<void>

Parameters

options
MediaOptions

Per-operation options (media options, device-select options, or capture override depending on context). See MediaOptions.

Returns

Promise<void>

addVideoInputDevice()

1addVideoInputDevice(options?): Promise<void>

Parameters

options
{ constraints?: MediaTrackConstraints; stream?: MediaStream; }

Per-operation options (media options, device-select options, or capture override depending on context). See MediaTrackConstraints and MediaStream.

Returns

Promise<void>

disableStudioAudio()

1disableStudioAudio(): Promise<void>

Returns

Promise<void>

enableStudioAudio()

1enableStudioAudio(): Promise<void>

Returns

Promise<void>

end()

1end(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.end

mute()

1mute(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.mute

muteVideo()

1muteVideo(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.muteVideo

remove()

1remove(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.remove

removeAdditionalDevice()

1removeAdditionalDevice(id): Promise<void>

Parameters

id
stringRequired

Unique participant ID, assigned by the media server.

Returns

Promise<void>

selectAudioInputDevice()

1selectAudioInputDevice(device, options?): void

Parameters

device
MediaDeviceInfoRequired

Media device to use for this participant. See MediaDeviceInfo.

options
SelectDeviceOptions

Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.

Returns

void

selectAudioOutputDevice()

1selectAudioOutputDevice(device, options?): void

Parameters

device
MediaDeviceInfoRequired

Media device to use for this participant. See MediaDeviceInfo.

options
SelectDeviceOptions

Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.

Returns

void

selectVideoInputDevice()

1selectVideoInputDevice(device, options?): void

Parameters

device
MediaDeviceInfoRequired

Media device to use for this participant. See MediaDeviceInfo.

options
SelectDeviceOptions

Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.

Returns

void

setAudioInputDeviceConstraints()

1setAudioInputDeviceConstraints(constraints): Promise<void>

Parameters

constraints
MediaTrackConstraintsRequired

Media-track constraints applied to this participant’s input. See MediaTrackConstraints.

Returns

Promise<void>

setAudioInputSensitivity()

1setAudioInputSensitivity(value): Promise<void>

Parameters

value
numberRequired

New value for the property being set.

Returns

Promise<void>

Inherited from

CallParticipant.setAudioInputSensitivity

setAudioInputVolume()

1setAudioInputVolume(value): Promise<void>

Parameters

value
numberRequired

New value for the property being set.

Returns

Promise<void>

Inherited from

CallParticipant.setAudioInputVolume

setAudioOutputVolume()

1setAudioOutputVolume(value): Promise<void>

Parameters

value
numberRequired

New value for the property being set.

Returns

Promise<void>

Inherited from

CallParticipant.setAudioOutputVolume

setInputDevicesConstraints()

1setInputDevicesConstraints(constraints): Promise<void>

Parameters

constraints
{ audio: MediaTrackConstraints; video: MediaTrackConstraints; }Required

Media-track constraints applied to this participant’s input. See MediaTrackConstraints.

Returns

Promise<void>

setMeta()

1setMeta(meta): Promise<void>

Parameters

meta
Record<string, unknown>Required

Arbitrary metadata bag for the local participant, if any.

Returns

Promise<void>

Inherited from

CallParticipant.setMeta

setPosition()

1setPosition(value): Promise<void>

Parameters

value
VideoPositionRequired

New value for the property being set. See VideoPosition.

Returns

Promise<void>

Inherited from

CallParticipant.setPosition

setVideoInputDeviceConstraints()

1setVideoInputDeviceConstraints(constraints): Promise<void>

Parameters

constraints
MediaTrackConstraintsRequired

Media-track constraints applied to this participant’s input. See MediaTrackConstraints.

Returns

Promise<void>

startScreenShare()

1startScreenShare(): Promise<void>

Returns

Promise<void>

stopScreenShare()

1stopScreenShare(): Promise<void>

Returns

Promise<void>

toggleAudioInputAutoGain()

1toggleAudioInputAutoGain(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleAudioInputAutoGain

toggleDeaf()

1toggleDeaf(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleDeaf

toggleEchoCancellation()

1toggleEchoCancellation(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleEchoCancellation

toggleHandraise()

1toggleHandraise(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleHandraise

toggleLowbitrate()

1toggleLowbitrate(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleLowbitrate

toggleMute()

1toggleMute(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleMute

toggleMuteVideo()

1toggleMuteVideo(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleMuteVideo

toggleNoiseSuppression()

1toggleNoiseSuppression(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.toggleNoiseSuppression

unmute()

1unmute(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.unmute

unmuteVideo()

1unmuteVideo(): Promise<void>

Returns

Promise<void>

Inherited from

CallParticipant.unmuteVideo

updateMeta()

1updateMeta(meta): Promise<void>

Parameters

meta
Record<string, unknown>Required

Arbitrary metadata bag for the local participant, if any.

Returns

Promise<void>

Inherited from

CallParticipant.updateMeta