Properties:
Name | Type | Argument | Description |
---|---|---|---|
isSubscribed |
boolean | whether the published RemoteTrack is subscribed to |
|
isTrackEnabled |
boolean | whether the published RemoteTrack is enabled |
|
kind |
Track.Kind | kind of the published RemoteTrack |
|
publishPriority |
Track.Priority | the Track.Priority of the published RemoteTrack set by the RemoteParticipant |
|
track |
RemoteTrack |
<nullable> |
Unless you have subscribed to the RemoteTrack, this property is null |
Fires:
- RemoteTrackPublication#event:publishPriorityChanged
- RemoteTrackPublication#event:subscribed
- RemoteTrackPublication#event:subscriptionFailed
- RemoteTrackPublication#event:trackDisabled
- RemoteTrackPublication#event:trackEnabled
- RemoteTrackPublication#event:trackSwitchedOff
- RemoteTrackPublication#event:trackSwitchedOn
- RemoteTrackPublication#event:unsubscribed
Extends
Events
-
publishPriorityChanged
-
The RemoteTrack's publish Track.Priority was changed by the RemoteParticipant.
Parameters:
Name Type Description priority
Track.Priority the RemoteTrack's new publish Track.Priority; RemoteTrackPublication#publishPriority is also updated accordingly
-
subscribed
-
Your LocalParticipant subscribed to the RemoteTrack.
Parameters:
Name Type Description track
RemoteTrack the RemoteTrack that was subscribed to
-
subscriptionFailed
-
Your LocalParticipant failed to subscribe to the RemoteTrack.
Parameters:
Name Type Description error
TwilioError the reason the RemoteTrack could not be subscribed to
-
trackDisabled
-
The RemoteTrack was disabled.
- Overrides:
-
trackEnabled
-
The RemoteTrack was enabled.
- Overrides:
-
trackSwitchedOff
-
The RemoteTrack was switched off.
Parameters:
Name Type Description track
RemoteTrack the RemoteTrack that was switched off
-
trackSwitchedOn
-
The RemoteTrack was switched on.
Parameters:
Name Type Description track
RemoteTrack the RemoteTrack that was switched on
-
unsubscribed
-
Your LocalParticipant unsubscribed from the RemoteTrack.
Parameters:
Name Type Description track
RemoteTrack the RemoteTrack that was unsubscribed from