Class LocalMediaHandler

Provides access to methods for managing actions related to local media. Instances of this class are obtained calling getLocalMediaHandler

Events
  • videoStream - Emitted every time videoStream changes.
  • * - Emitted every time a change that can affect to any property happens.

Hierarchy

  • LocalMediaHandler

Properties

_audioMuted _audioOnlyStream? _beforeShareScreenVideo _mediaConstraints _mediaTypes _updateMedia _videoMuted _videoStream? activeAudioInputDevice activeAudioInputDevice$ activeVideoInputDevice activeVideoInputDevice$ audioInputDevices$ audioOutputDevices$ canToggleCamera$ canToggleVideo$ devices$ emitter forceRefreshDevices subscription videoInputDevices$

Methods

addVideo forceUpdateDevices getActiveVideoInputDeviceFromLocalStreams getCurrentMediaConstraints getMediaConstraints getMediaTypes getNextVideoInputDevice getVideoStream hasAudioTrack hasVideoTrack isAudioMuted isVideoMuted muteAudio muteVideo setActiveAudioInputDevice setActiveVideoInputDevice setMediaConstraints setMediaTypes toggleCamera toggleScreen toggleVideo uninit

Properties

Private _audioMuted

_audioMuted: boolean = false

Private Optional _audioOnlyStream

_audioOnlyStream?: ManagedStream

Private _beforeShareScreenVideo

_beforeShareScreenVideo: boolean = true

Private _mediaConstraints

_mediaConstraints: MediaStreamConstraints

Private _mediaTypes

_mediaTypes: MediaTypes = ...

Private _updateMedia

_updateMedia: UpdateMedia

Private _videoMuted

_videoMuted: boolean = false

Private Optional _videoStream

_videoStream?: ManagedStream

Private activeAudioInputDevice

activeAudioInputDevice: BehaviorSubject<undefined | MediaDeviceInfo> = ...

Readonly activeAudioInputDevice$

activeAudioInputDevice$: Observable<undefined | MediaDeviceInfo>

The MediaDeviceInfo of the active audio device

Private activeVideoInputDevice

activeVideoInputDevice: BehaviorSubject<undefined | MediaDeviceInfo> = ...

Readonly activeVideoInputDevice$

activeVideoInputDevice$: Observable<undefined | MediaDeviceInfo>

The MediaDeviceInfo of the active video device

Readonly audioInputDevices$

audioInputDevices$: Observable<MediaDeviceInfo[]>

The list of available audio input devices

Readonly audioOutputDevices$

audioOutputDevices$: Observable<MediaDeviceInfo[]>

The list of available video input devices

canToggleCamera$

canToggleCamera$: Observable<boolean>

Indicates if it is possible to change to a different camera

canToggleVideo$

canToggleVideo$: Observable<boolean>

Indicates if video can be enabled or disabled

Private devices$

devices$: Observable<MediaDeviceInfo[]>

Readonly emitter

emitter: EventEmitter<Events, any> = ...

Private forceRefreshDevices

forceRefreshDevices: Subject<void> = ...

Private subscription

subscription: Subscription = ...

Readonly videoInputDevices$

videoInputDevices$: Observable<MediaDeviceInfo[]>

The list of available audio output devices

Methods

addVideo

  • 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

Private getActiveVideoInputDeviceFromLocalStreams

  • Returns Promise<undefined | MediaDeviceInfo>

getCurrentMediaConstraints

  • 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 | MediaStreamConstraints;
          mediaTypes: undefined | MediaTypes;
      } = {}
      • mediaConstraints: undefined | MediaStreamConstraints
      • mediaTypes: undefined | MediaTypes

    Returns MediaStreamConstraints

getMediaConstraints

  • Return the media constraints configured for the call

    Returns MediaStreamConstraints

getMediaTypes

Private getNextVideoInputDevice

getVideoStream

hasAudioTrack

hasVideoTrack

isAudioMuted

isVideoMuted

muteAudio

  • 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

  • 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 toggleVideo.

    Parameters

    • mute: boolean = !this.isVideoMuted()

      When specified forces video to be mute or unmute

    Returns void

setActiveAudioInputDevice

  • 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

  • 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

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

    Example

    Change video resolution

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

    Parameters

    • mediaConstraints: MediaStreamConstraints

      The requested media constraints

    Returns Promise<void>

setMediaTypes

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

    Example

    Disable video

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

    Parameters

    Returns Promise<void>

toggleCamera

toggleScreen

  • 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

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc