Local Participant

Introduction

The LocalParticipant object handles, sends and updates the current publishing user throughout the lifetime of the call.

Methods

Name Description
publishAudio(publish: boolean) Set's the publishing state of the user's audio for the session.
publishVideo(publish: boolean) Set's the publishing state of the user's video for the session.
setVideoSource(deviceId: string) Sets the video source for the current session
setAudioSource(deviceId: string) Sets the audio source for the current session

publishAudio(publish: boolean)

Sets the device toSet's the publishing state of the user's audio for the session

localParticipant.publishAudio(publish: boolean)

publishVideo(publish: boolean)

Set's the publishing state of the user's video for the session,

localParticipant.publishVideo(publish: boolean)

setVideoSource(deviceId: string)

Sets the video source for the current session, has to be valid deviceId returned by the devicesUpdated handler in the Conference object.

localParticipant.setVideoSource(deviceId: string)

setAudioSource(deviceId: string)

Sets the audio source for the current session, has to be valid deviceId returned by the devicesUpdated handler in the Conference object.

localParticipant.setAudioSource(deviceId: string)

Listeners

'videoCreated' -> {HTMLVideoElement}

When the local stream of the current user is published, the videoCreated object is emitted which is a video element that can be pushed to the DOM.

localParticipant.on('videoCreated', (HTMLVideoElement) => {})