Documentation

Class: RemoteAudioTrackPublication

RemoteAudioTrackPublication

A RemoteAudioTrackPublication represents a RemoteAudioTrack that has been published to a Room.

Properties:
Name Type Argument Description
kind Track.Kind

"audio"
track RemoteAudioTrack <nullable>

unless you have subscribed to the RemoteAudioTrack, this property is null
Fires:

Events

subscribed

Your LocalParticipant subscribed to the RemoteAudioTrack.

Parameters:
Name Type Description
track RemoteAudioTrack

the RemoteAudioTrack that was subscribed to

subscriptionFailed

Your LocalParticipant failed to subscribe to the RemoteAudioTrack.

Parameters:
Name Type Description
error TwilioError

the reason the RemoteAudioTrack could not be subscribed to

trackDisabled

The RemoteAudioTrack was disabled. It is fired only if .isSubscribed is set to true (Deprecated only for large group Rooms).

Deprecated:
  • Use trackSwitchedOff (track.switchOffReason === "disabled-by-publisher") instead

trackEnabled

The RemoteAudioTrack was enabled. It is fired only if .isSubscribed is set to true (Deprecated only for large group Rooms).

Deprecated:

trackSwitchedOff

The RemoteAudioTrack was switched off. The media server stops sending media for the RemoteAudioTrack until it is switched back on. Just before the event is raised, isSwitchedOff is set to true and switchOffReason is set to a TrackSwitchOffReason in large group Rooms (switchOffReason is null non-large group Rooms). Also, if the RemoteAudioTrack receives audio media, the mediaStreamTrack property is set to null. (only in large group Rooms)

Parameters:
Name Type Argument Description
track RemoteAudioTrack

the RemoteAudioTrack that was switched off
switchOffReason TrackSwitchOffReason <nullable>

the reason the RemoteAudioTrack was switched off

trackSwitchedOn

The RemoteAudioTrack was switched on. The media server starts sending media for the RemoteAudioTrack until it is switched off. Just before the event is raised, isSwitchedOff is set to false and switchOffReason is set to null. Also, the mediaStreamTrack property is set to a MediaStreamTrack that is the source of the RemoteAudioTrack's media.

Parameters:
Name Type Description
track RemoteAudioTrack

the RemoteAudioTrack that was switched on

unsubscribed

Your LocalParticipant unsubscribed from the RemoteAudioTrack.

Parameters:
Name Type Description
track RemoteAudioTrack

the RemoteAudioTrack that was unsubscribed from