CallParticipant
Base participant interface for call participants Defines the full public contract for participant objects exposed by Call
Extended by
Properties
addressId
User-address ID, if this participant is a known user.
addressId$
Observable of user-address ID, if this participant is a known user.
audioMuted
Whether this participant’s audio is muted.
audioMuted$
Observable of whether this participant’s audio is muted.
autoGain
Whether automatic gain control is enabled on this participant’s microphone.
autoGain$
Observable of whether automatic gain control is enabled on this participant’s microphone.
deaf
Whether this participant is deafened (does not receive other participants’ audio).
deaf$
Observable of whether this participant is deafened (does not receive other participants’ audio).
denoise
Whether noise suppression is enabled on this participant’s microphone.
denoise$
Observable of whether noise suppression is enabled on this participant’s microphone.
echoCancellation
Whether echo cancellation is enabled on this participant’s microphone.
echoCancellation$
Observable of whether echo cancellation is enabled on this participant’s microphone.
handraised
Whether this participant has their hand raised.
handraised$
Observable of whether this participant has their hand raised.
id
Unique participant ID, assigned by the media server.
inputSensitivity
Microphone input sensitivity, or undefined if not adjustable.
inputSensitivity$
Observable of microphone input sensitivity, or undefined if not adjustable.
inputVolume
Microphone input volume, or undefined if not adjustable.
inputVolume$
Observable of microphone input volume, or undefined if not adjustable.
isAudience
Whether this participant is an audience member rather than an active participant.
isTalking
Whether the media server currently detects voice activity from this participant.
isTalking$
Observable of whether the media server currently detects voice activity from this participant.
lowbitrate
Whether low-bitrate mode is enabled for this participant.
lowbitrate$
Observable of whether low-bitrate mode is enabled for this participant.
meta
Arbitrary metadata bag for this participant, if any.
meta$
Observable of the call-level metadata bag.
name
Display name of this participant.
name$
Observable of display name of this participant.
nodeId
ID of the media node hosting this participant.
nodeId$
Observable of the media node ID currently hosting the call.
noiseSuppression
Whether noise suppression is enabled on this participant’s microphone.
noiseSuppression$
Observable of whether noise suppression is enabled on this participant’s microphone.
outputVolume
Speaker output volume for this participant, or undefined if not adjustable.
outputVolume$
Observable of speaker output volume for this participant, or undefined if not adjustable.
position
Current layout position of this participant, or undefined if not yet placed. See LayoutLayer.
position$
Observable of current layout position of this participant, or undefined if not yet placed. See LayoutLayer.
userId
User ID associated with this participant, if known.
userId$
Observable of user ID associated with this participant, if known.
type
Participant type (e.g. member, audience).
type$
Observable of participant type (e.g. member, audience).
videoMuted
Whether this participant’s video is muted.
videoMuted$
Observable of whether this participant’s video is muted.
visible
Whether this participant is currently visible in the layout.
visible$
Observable of whether this participant is currently visible in the layout.
Methods
end()
Returns
Promise<void>
mute()
Returns
Promise<void>
muteVideo()
Returns
Promise<void>
remove()
Returns
Promise<void>
setAudioInputSensitivity()
Parameters
value
New value for the property being set.
Returns
Promise<void>
setAudioInputVolume()
Parameters
value
New value for the property being set.
Returns
Promise<void>
setAudioOutputVolume()
Parameters
value
New value for the property being set.
Returns
Promise<void>
setMeta()
Parameters
meta
Arbitrary metadata bag for this participant, if any.
Returns
Promise<void>
setPosition()
Parameters
value
New value for the property being set. See VideoPosition.
Returns
Promise<void>
toggleAudioInputAutoGain()
Returns
Promise<void>
toggleDeaf()
Returns
Promise<void>
toggleEchoCancellation()
Returns
Promise<void>
toggleHandraise()
Returns
Promise<void>
toggleLowbitrate()
Returns
Promise<void>
toggleMute()
Returns
Promise<void>
toggleMuteVideo()
Returns
Promise<void>
toggleNoiseSuppression()
Returns
Promise<void>
unmute()
Returns
Promise<void>
unmuteVideo()
Returns
Promise<void>
updateMeta()
Parameters
meta
Arbitrary metadata bag for this participant, if any.
Returns
Promise<void>