SignalWire DocsSelf participant interface with control methods Extends CallParticipant with methods for controlling the local participant
Current screen-share status for this participant. See ScreenShareStatus.
Observable of current screen-share status for this participant. See ScreenShareStatus.
Whether studio-audio processing is enabled for this participant.
Observable of whether studio-audio processing is enabled for this participant.
User-address ID, if this participant is a known user.
Observable of user-address ID, if this participant is a known user.
Whether this participant’s audio is muted.
Observable of whether this participant’s audio is muted.
Whether automatic gain control is enabled on this participant’s microphone.
Observable of whether automatic gain control is enabled on this participant’s microphone.
Whether this participant is deafened (does not receive other participants’ audio).
Observable of whether this participant is deafened (does not receive other participants’ audio).
Whether noise suppression is enabled on this participant’s microphone.
Observable of whether noise suppression is enabled on this participant’s microphone.
Whether echo cancellation is enabled on this participant’s microphone.
Observable of whether echo cancellation is enabled on this participant’s microphone.
Whether this participant has their hand raised.
Observable of whether this participant has their hand raised.
Unique participant ID, assigned by the media server.
Microphone input sensitivity, or undefined if not adjustable.
Observable of microphone input sensitivity, or undefined if not adjustable.
Microphone input volume, or undefined if not adjustable.
Observable of microphone input volume, or undefined if not adjustable.
Whether this participant is an audience member rather than an active participant.
Whether the media server currently detects voice activity from this participant.
Observable of whether the media server currently detects voice activity from this participant.
Whether low-bitrate mode is enabled for this participant.
Observable of whether low-bitrate mode is enabled for this participant.
Arbitrary metadata bag for the local participant, if any.
Observable of the call-level metadata bag.
Display name of this participant.
Observable of display name of this participant.
ID of the media node hosting this participant.
Observable of the media node ID currently hosting the call.
Whether noise suppression is enabled on this participant’s microphone.
Observable of whether noise suppression is enabled on this participant’s microphone.
Speaker output volume for this participant, or undefined if not adjustable.
Observable of speaker output volume for this participant, or undefined if not adjustable.
Current layout position of this participant, or undefined if not yet placed. See LayoutLayer.
Observable of current layout position of this participant, or undefined if not yet placed. See LayoutLayer.
User ID associated with this participant, if known.
Observable of user ID associated with this participant, if known.
Participant type (e.g. member, audience).
Observable of participant type (e.g. member, audience).
Whether this participant’s video is muted.
Observable of whether this participant’s video is muted.
Whether this participant is currently visible in the layout.
Observable of whether this participant is currently visible in the layout.
Per-operation options (media options, device-select options, or capture override depending on context). See MediaOptions.
Promise<void>
Per-operation options (media options, device-select options, or capture override depending on context). See MediaTrackConstraints and MediaStream.
Promise<void>
Per-operation options (media options, device-select options, or capture override depending on context). See MediaOptions.
Promise<void>
Per-operation options (media options, device-select options, or capture override depending on context). See MediaTrackConstraints and MediaStream.
Promise<void>
Promise<void>
Promise<void>
Promise<void>
Promise<void>
Promise<void>
Promise<void>
Unique participant ID, assigned by the media server.
Promise<void>
Media device to use for this participant. See MediaDeviceInfo.
Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.
void
Media device to use for this participant. See MediaDeviceInfo.
Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.
void
Media device to use for this participant. See MediaDeviceInfo.
Per-operation options (media options, device-select options, or capture override depending on context). See SelectDeviceOptions.
void
Media-track constraints applied to this participant’s input. See MediaTrackConstraints.
Promise<void>
New value for the property being set.
Promise<void>
CallParticipant.setAudioInputSensitivity
New value for the property being set.
Promise<void>
CallParticipant.setAudioInputVolume
New value for the property being set.
Promise<void>
CallParticipant.setAudioOutputVolume
Media-track constraints applied to this participant’s input. See MediaTrackConstraints.
Promise<void>
Arbitrary metadata bag for the local participant, if any.
Promise<void>
New value for the property being set. See VideoPosition.
Promise<void>
Media-track constraints applied to this participant’s input. See MediaTrackConstraints.
Promise<void>
Promise<void>
Promise<void>
Promise<void>
CallParticipant.toggleAudioInputAutoGain
Promise<void>
Promise<void>
CallParticipant.toggleEchoCancellation
Promise<void>
CallParticipant.toggleHandraise
Promise<void>
CallParticipant.toggleLowbitrate
Promise<void>
Promise<void>
CallParticipant.toggleMuteVideo
Promise<void>
CallParticipant.toggleNoiseSuppression
Promise<void>
Promise<void>
Arbitrary metadata bag for the local participant, if any.
Promise<void>