Class LocalMediaHandler

Readonly activeAudioInputDevice$

Readonly activeVideoInputDevice$

Readonly audioInputDevices$

Readonly audioOnlyStream$

Readonly audioOutputDevices$

Readonly canToggleCamera$

Readonly canToggleVideo$

Readonly isAudioMuted$

Readonly isPushToTalkActive$

Readonly isVideoMuted$

Readonly mediaConstraints$

Readonly mediaTypes$

Readonly videoInputDevices$

Readonly videoStream$

audioOnlyStream

• get audioOnlyStream(): undefined | ManagedStream

• Returns the local audio stream

  Returns undefined | ManagedStream

backgroundEffect

• get backgroundEffect(): BackgroundEffect

• Returns BackgroundEffect

• set backgroundEffect(backgroundEffect): void

• Parameters

  • backgroundEffect: BackgroundEffect

  Returns void

isAudioMuted

• get isAudioMuted(): boolean

• Indicates if local audio is muted

  Returns boolean

isVideoMuted

• get isVideoMuted(): boolean

• Indicates if local video is muted

  Returns boolean

mediaConstraints

• get mediaConstraints(): Readonly<MediaStreamConstraints>

• Return the media constraints configured for the call

  Returns Readonly<MediaStreamConstraints>

mediaTypes

• get mediaTypes(): Readonly<MediaTypes>

• Return the media types configured for the call

  Returns Readonly<MediaTypes>

videoStream

• get videoStream(): undefined | ManagedStream

• Returns the local video stream

  Returns undefined | ManagedStream

addVideo

• addVideo(): Promise<void>

• Updates media types adding video when screen is false or adds an internal mark to know video must be enabled when screen sharing ends.

  Returns Promise<void>

forceUpdateDevices

• forceUpdateDevices(): Promise<void>

• Force the update of the devices list

  Returns Promise<void>

getCurrentMediaConstraints

• getCurrentMediaConstraints(__namedParameters?): Readonly<MediaStreamConstraints>

• Obtains current enabled media stream constraints. This is a combination of the media stream constraints configured for the call and the current media types.

  Parameters

  • __namedParameters: {
        mediaConstraints: undefined | Readonly<MediaStreamConstraints>;
        mediaTypes: undefined | Readonly<MediaTypes>;
    } = {}

    • mediaConstraints: undefined | Readonly<MediaStreamConstraints>

    • mediaTypes: undefined | Readonly<MediaTypes>

  Returns Readonly<MediaStreamConstraints>

muteAudio

• muteAudio(mute?): void

• Mutes or unmutes the audio. If no parameter is specified it toggles current value.

  Parameters

  • mute: boolean = !this.isAudioMuted

    If specified forces audio to be mute or unmute

  Returns void

muteVideo

• muteVideo(mute?): void

• Mutes or unmutes the video. If no parameter is specified it toggles current value.

  Note that this method just turns the emitted video black and implies no media renegotiation. Therefore, a video track will continue to be streamed. If you are instead looking for a method to stop sending video altogether check LocalMediaHandler.toggleVideo.

  Parameters

  • mute: boolean = !this.isVideoMuted

    When specified forces video to be mute or unmute

  Returns void

setActiveAudioInputDevice

• setActiveAudioInputDevice(audioInputDevice?): Promise<void>

• Updates the audio input device in used to the specified one

  Parameters

  • Optional audioInputDevice: MediaDeviceInfo

    If no value is specified the default one is selected

  Returns Promise<void>

setActiveVideoInputDevice

• setActiveVideoInputDevice(videoInputDevice?): Promise<void>

• Updates the video input device in used to the specified one

  Parameters

  • Optional videoInputDevice: MediaDeviceInfo

    If no value is specified the default one is selected

  Returns Promise<void>

setMediaConstraints

• setMediaConstraints(mediaConstraints): Promise<void>

• Update constraints of local media. This feature is only available when the call has already been connected if "media-update" capability is present.

  Parameters

  • mediaConstraints: Readonly<MediaStreamConstraints>

    The requested media constraints

  Returns Promise<void>

  Example: Change video resolution

  const audio = true;
  const video = {
    height: 256,
    width: 256,
  };
  await call.setMediaConstraints({audio, video});
  console.log("media updated");
  Copy

setMediaTypes

• setMediaTypes(mediaTypes): Promise<void>

• Update the enabled local media. This feature is only available when the call has already been connected if "media-update" capability is present.

  Parameters

  • mediaTypes: Readonly<MediaTypes>

    The requested media

  Returns Promise<void>

  Example: Disable video

  await call.setMediaTypes({audio: true, video: false, screen: false});
  console.log("media updated");
  Copy

startPushToTalk

• startPushToTalk(): void

• Turns on the microphone until stopPushToTalk method is called. Does nothing if microphone is not muted

  Returns void

stopPushToTalk

• stopPushToTalk(): void

• Turns off the microphone again. Does nothing if startPushToTalk was not called before

  Returns void

toggleCamera

• toggleCamera(): Promise<void>

• Changes the local video stream to the next available camera.

  Returns Promise<void>

toggleScreen

• toggleScreen(screen?): Promise<void>

• Shares the screen. This feature is only available if "screen-sharing" capability is present.

  Parameters

  • screen: boolean = !this.mediaTypes.screen

    send screen if true, camera if false. If not specified it toggles from the last state.

  Returns Promise<void>

toggleVideo

• toggleVideo(video?): Promise<void>

• Enables or disables the video. If no parameter is specified it toggles current value.

  Note that this method will imply a media renegotation because the video track will be added or removed from the RTCPeerConnection. As a consequence, remote participants will receive a change in their remote participants streams.

  Parameters

  • video: boolean = !this.mediaTypes.video

    If specified forces video to be enabled or not

  Returns Promise<void>

uninit

• uninit(): void

• Returns void