Documentation

Class: LocalDataTrackPublication

LocalDataTrackPublication

A LocalDataTrackPublication is a LocalDataTrack that has been published to a Room.

Properties:
Name Type Description
kind Track.Kind

"data"
track LocalDataTrack

the LocalDataTrack

Extends

Methods

setPriority(priority)

Update the Track.Priority of the published LocalTrack.

Parameters:
Name Type Description
priority Track.Priority

the new Track.priority
Inherited From:
Overrides:
Throws:
RangeError
Returns:
Type
this

unpublish()

Unpublish a LocalTrackPublication. This means that the media from this LocalTrackPublication is no longer available to the Room's RemoteParticipants.

Inherited From:
Overrides:
Returns:
Type
this

Events

trackDisabled

The published Track was disabled.

Inherited From:
Overrides:

trackEnabled

The published Track was enabled.

Inherited From:
Overrides:

warning

The published LocalTrack encountered a warning. This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

Parameters:
Name Type Description
name string

The warning that was raised.
Inherited From:
Overrides:

warningsCleared

The published LocalTrack cleared all warnings. This event is only raised if you enabled warnings using notifyWarnings in ConnectOptions.

Inherited From:
Overrides: