Documentation

Class: LocalTrack

LocalTrack

A LocalTrack represents audio or video that your Client is sending to a Room. As such, it can be enabled and disabled with LocalTrack#enable and LocalTrack#disable or stopped completely with LocalTrack#stop.

Extends

Methods

disable()

Disable the LocalTrack.

Fires:
Returns:
Type
this

enable( [enabled])

Enable or disable the LocalTrack.

Parameters:
Name Type Argument Description
enabled boolean <optional>

Specify false to disable the LocalTrack
Fires:
Returns:
Type
this

enable()

Enable the LocalTrack.

Fires:
Returns:
Type
this

stop()

Calls stop on the underlying MediaStreamTrack. If you choose to stop a LocalTrack, you should use LocalMedia#removeTrack to remove it after stopping. You do not need to stop a track before using LocalTrack#disable or LocalMedia#removeTrack.

Returns:
Type
this

Events

disabled

The Track was disabled. For AudioTracks this means "muted", and for VideoTracks this means "paused".

Parameters:
Name Type Description
track Track

The Track that was disabled
Inherited From:

enabled

The Track was enabled. For AudioTracks this means "unmuted", and for VideoTracks this means "unpaused".

Parameters:
Name Type Description
track Track

The Track that was enabled
Inherited From:

started

The Track started. This means that the Track contains enough audio or video to begin playback.

Parameters:
Name Type Description
track Track

The Track that started
Inherited From: