/
RemoteTrackPublication.ts
319 lines (279 loc) · 9.2 KB
/
RemoteTrackPublication.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
import {
ParticipantTracks,
SubscriptionError,
TrackInfo,
UpdateSubscription,
UpdateTrackSettings,
} from '@livekit/protocol';
import { TrackEvent } from '../events';
import type { LoggerOptions } from '../types';
import type RemoteTrack from './RemoteTrack';
import RemoteVideoTrack from './RemoteVideoTrack';
import { Track, VideoQuality } from './Track';
import { TrackPublication } from './TrackPublication';
export default class RemoteTrackPublication extends TrackPublication {
track?: RemoteTrack = undefined;
/** @internal */
protected allowed = true;
// keeps track of client's desire to subscribe to a track, also true if autoSubscribe is active
protected subscribed?: boolean;
protected disabled: boolean = false;
protected currentVideoQuality?: VideoQuality = VideoQuality.HIGH;
protected videoDimensions?: Track.Dimensions;
protected fps?: number;
protected subscriptionError?: SubscriptionError;
constructor(
kind: Track.Kind,
ti: TrackInfo,
autoSubscribe: boolean | undefined,
loggerOptions?: LoggerOptions,
) {
super(kind, ti.sid, ti.name, loggerOptions);
this.subscribed = autoSubscribe;
this.updateInfo(ti);
}
/**
* Subscribe or unsubscribe to this remote track
* @param subscribed true to subscribe to a track, false to unsubscribe
*/
setSubscribed(subscribed: boolean) {
const prevStatus = this.subscriptionStatus;
const prevPermission = this.permissionStatus;
this.subscribed = subscribed;
// reset allowed status when desired subscription state changes
// server will notify client via signal message if it's not allowed
if (subscribed) {
this.allowed = true;
}
const sub = new UpdateSubscription({
trackSids: [this.trackSid],
subscribe: this.subscribed,
participantTracks: [
new ParticipantTracks({
// sending an empty participant id since TrackPublication doesn't keep it
// this is filled in by the participant that receives this message
participantSid: '',
trackSids: [this.trackSid],
}),
],
});
this.emit(TrackEvent.UpdateSubscription, sub);
this.emitSubscriptionUpdateIfChanged(prevStatus);
this.emitPermissionUpdateIfChanged(prevPermission);
}
get subscriptionStatus(): TrackPublication.SubscriptionStatus {
if (this.subscribed === false) {
return TrackPublication.SubscriptionStatus.Unsubscribed;
}
if (!super.isSubscribed) {
return TrackPublication.SubscriptionStatus.Desired;
}
return TrackPublication.SubscriptionStatus.Subscribed;
}
get permissionStatus(): TrackPublication.PermissionStatus {
return this.allowed
? TrackPublication.PermissionStatus.Allowed
: TrackPublication.PermissionStatus.NotAllowed;
}
/**
* Returns true if track is subscribed, and ready for playback
*/
get isSubscribed(): boolean {
if (this.subscribed === false) {
return false;
}
return super.isSubscribed;
}
// returns client's desire to subscribe to a track, also true if autoSubscribe is enabled
get isDesired(): boolean {
return this.subscribed !== false;
}
get isEnabled(): boolean {
return !this.disabled;
}
/**
* disable server from sending down data for this track. this is useful when
* the participant is off screen, you may disable streaming down their video
* to reduce bandwidth requirements
* @param enabled
*/
setEnabled(enabled: boolean) {
if (!this.isManualOperationAllowed() || this.disabled === !enabled) {
return;
}
this.disabled = !enabled;
this.emitTrackUpdate();
}
/**
* for tracks that support simulcasting, adjust subscribed quality
*
* This indicates the highest quality the client can accept. if network
* bandwidth does not allow, server will automatically reduce quality to
* optimize for uninterrupted video
*/
setVideoQuality(quality: VideoQuality) {
if (!this.isManualOperationAllowed() || this.currentVideoQuality === quality) {
return;
}
this.currentVideoQuality = quality;
this.videoDimensions = undefined;
this.emitTrackUpdate();
}
setVideoDimensions(dimensions: Track.Dimensions) {
if (!this.isManualOperationAllowed()) {
return;
}
if (
this.videoDimensions?.width === dimensions.width &&
this.videoDimensions?.height === dimensions.height
) {
return;
}
if (this.track instanceof RemoteVideoTrack) {
this.videoDimensions = dimensions;
}
this.currentVideoQuality = undefined;
this.emitTrackUpdate();
}
setVideoFPS(fps: number) {
if (!this.isManualOperationAllowed()) {
return;
}
if (!(this.track instanceof RemoteVideoTrack)) {
return;
}
if (this.fps === fps) {
return;
}
this.fps = fps;
this.emitTrackUpdate();
}
get videoQuality(): VideoQuality | undefined {
return this.currentVideoQuality;
}
/** @internal */
setTrack(track?: RemoteTrack) {
const prevStatus = this.subscriptionStatus;
const prevPermission = this.permissionStatus;
const prevTrack = this.track;
if (prevTrack === track) {
return;
}
if (prevTrack) {
// unregister listener
prevTrack.off(TrackEvent.VideoDimensionsChanged, this.handleVideoDimensionsChange);
prevTrack.off(TrackEvent.VisibilityChanged, this.handleVisibilityChange);
prevTrack.off(TrackEvent.Ended, this.handleEnded);
prevTrack.detach();
prevTrack.stopMonitor();
this.emit(TrackEvent.Unsubscribed, prevTrack);
}
super.setTrack(track);
if (track) {
track.sid = this.trackSid;
track.on(TrackEvent.VideoDimensionsChanged, this.handleVideoDimensionsChange);
track.on(TrackEvent.VisibilityChanged, this.handleVisibilityChange);
track.on(TrackEvent.Ended, this.handleEnded);
this.emit(TrackEvent.Subscribed, track);
}
this.emitPermissionUpdateIfChanged(prevPermission);
this.emitSubscriptionUpdateIfChanged(prevStatus);
}
/** @internal */
setAllowed(allowed: boolean) {
const prevStatus = this.subscriptionStatus;
const prevPermission = this.permissionStatus;
this.allowed = allowed;
this.emitPermissionUpdateIfChanged(prevPermission);
this.emitSubscriptionUpdateIfChanged(prevStatus);
}
/** @internal */
setSubscriptionError(error: SubscriptionError) {
this.emit(TrackEvent.SubscriptionFailed, error);
}
/** @internal */
updateInfo(info: TrackInfo) {
super.updateInfo(info);
const prevMetadataMuted = this.metadataMuted;
this.metadataMuted = info.muted;
if (this.track) {
this.track.setMuted(info.muted);
} else if (prevMetadataMuted !== info.muted) {
this.emit(info.muted ? TrackEvent.Muted : TrackEvent.Unmuted);
}
}
private emitSubscriptionUpdateIfChanged(previousStatus: TrackPublication.SubscriptionStatus) {
const currentStatus = this.subscriptionStatus;
if (previousStatus === currentStatus) {
return;
}
this.emit(TrackEvent.SubscriptionStatusChanged, currentStatus, previousStatus);
}
private emitPermissionUpdateIfChanged(
previousPermissionStatus: TrackPublication.PermissionStatus,
) {
const currentPermissionStatus = this.permissionStatus;
if (currentPermissionStatus !== previousPermissionStatus) {
this.emit(
TrackEvent.SubscriptionPermissionChanged,
this.permissionStatus,
previousPermissionStatus,
);
}
}
private isManualOperationAllowed(): boolean {
if (this.kind === Track.Kind.Video && this.isAdaptiveStream) {
this.log.warn(
'adaptive stream is enabled, cannot change video track settings',
this.logContext,
);
return false;
}
if (!this.isDesired) {
this.log.warn('cannot update track settings when not subscribed', this.logContext);
return false;
}
return true;
}
protected handleEnded = (track: RemoteTrack) => {
this.setTrack(undefined);
this.emit(TrackEvent.Ended, track);
};
protected get isAdaptiveStream(): boolean {
return this.track instanceof RemoteVideoTrack && this.track.isAdaptiveStream;
}
protected handleVisibilityChange = (visible: boolean) => {
this.log.debug(
`adaptivestream video visibility ${this.trackSid}, visible=${visible}`,
this.logContext,
);
this.disabled = !visible;
this.emitTrackUpdate();
};
protected handleVideoDimensionsChange = (dimensions: Track.Dimensions) => {
this.log.debug(
`adaptivestream video dimensions ${dimensions.width}x${dimensions.height}`,
this.logContext,
);
this.videoDimensions = dimensions;
this.emitTrackUpdate();
};
/* @internal */
emitTrackUpdate() {
const settings: UpdateTrackSettings = new UpdateTrackSettings({
trackSids: [this.trackSid],
disabled: this.disabled,
fps: this.fps,
});
if (this.videoDimensions) {
settings.width = Math.ceil(this.videoDimensions.width);
settings.height = Math.ceil(this.videoDimensions.height);
} else if (this.currentVideoQuality !== undefined) {
settings.quality = this.currentVideoQuality;
} else {
// defaults to high quality
settings.quality = VideoQuality.HIGH;
}
this.emit(TrackEvent.UpdateSettings, settings);
}
}