livekit-client 0.16.2 → 0.16.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/RequestQueue.d.ts +12 -0
- package/dist/api/RequestQueue.js +61 -0
- package/dist/api/RequestQueue.js.map +1 -0
- package/dist/api/SignalClient.d.ts +4 -1
- package/dist/api/SignalClient.js +14 -1
- package/dist/api/SignalClient.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/options.d.ts +0 -10
- package/dist/room/RTCEngine.d.ts +18 -4
- package/dist/room/RTCEngine.js +13 -5
- package/dist/room/RTCEngine.js.map +1 -1
- package/dist/room/Room.d.ts +43 -6
- package/dist/room/Room.js +62 -51
- package/dist/room/Room.js.map +1 -1
- package/dist/room/events.d.ts +8 -1
- package/dist/room/events.js +10 -3
- package/dist/room/events.js.map +1 -1
- package/dist/room/participant/LocalParticipant.js +2 -3
- package/dist/room/participant/LocalParticipant.js.map +1 -1
- package/dist/room/participant/Participant.d.ts +30 -4
- package/dist/room/participant/Participant.js +2 -2
- package/dist/room/participant/Participant.js.map +1 -1
- package/dist/room/participant/RemoteParticipant.d.ts +3 -4
- package/dist/room/participant/RemoteParticipant.js.map +1 -1
- package/dist/room/track/LocalAudioTrack.js +8 -1
- package/dist/room/track/LocalAudioTrack.js.map +1 -1
- package/dist/room/track/LocalVideoTrack.d.ts +1 -5
- package/dist/room/track/LocalVideoTrack.js +12 -117
- package/dist/room/track/LocalVideoTrack.js.map +1 -1
- package/dist/room/track/Track.d.ts +16 -3
- package/dist/room/track/Track.js +3 -1
- package/dist/room/track/Track.js.map +1 -1
- package/dist/room/track/types.d.ts +4 -4
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +2 -1
- package/src/api/RequestQueue.ts +53 -0
- package/src/api/SignalClient.ts +19 -1
- package/src/index.ts +1 -1
- package/src/options.ts +0 -12
- package/src/room/RTCEngine.ts +38 -7
- package/src/room/Room.ts +135 -59
- package/src/room/events.ts +10 -1
- package/src/room/participant/LocalParticipant.ts +1 -2
- package/src/room/participant/Participant.ts +39 -4
- package/src/room/participant/RemoteParticipant.ts +6 -4
- package/src/room/track/LocalAudioTrack.ts +8 -1
- package/src/room/track/LocalVideoTrack.ts +11 -142
- package/src/room/track/Track.ts +19 -3
- package/src/room/track/types.ts +4 -4
- package/src/version.ts +1 -1
package/src/room/Room.ts
CHANGED
@@ -1,4 +1,5 @@
|
|
1
1
|
import { EventEmitter } from 'events';
|
2
|
+
import type TypedEmitter from 'typed-emitter';
|
2
3
|
import { toProtoSessionDescription } from '../api/SignalClient';
|
3
4
|
import log from '../logger';
|
4
5
|
import { RoomConnectOptions, RoomOptions } from '../options';
|
@@ -44,7 +45,7 @@ export enum RoomState {
|
|
44
45
|
*
|
45
46
|
* @noInheritDoc
|
46
47
|
*/
|
47
|
-
class Room extends EventEmitter {
|
48
|
+
class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>) {
|
48
49
|
state: RoomState = RoomState.Disconnected;
|
49
50
|
|
50
51
|
/** map of sid: [[RemoteParticipant]] */
|
@@ -145,10 +146,12 @@ class Room extends EventEmitter {
|
|
145
146
|
.on(EngineEvent.Resuming, () => {
|
146
147
|
this.state = RoomState.Reconnecting;
|
147
148
|
this.emit(RoomEvent.Reconnecting);
|
149
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
148
150
|
})
|
149
151
|
.on(EngineEvent.Resumed, () => {
|
150
152
|
this.state = RoomState.Connected;
|
151
153
|
this.emit(RoomEvent.Reconnected);
|
154
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
152
155
|
this.updateSubscriptions();
|
153
156
|
})
|
154
157
|
.on(EngineEvent.SignalResumed, () => {
|
@@ -205,6 +208,7 @@ class Room extends EventEmitter {
|
|
205
208
|
}
|
206
209
|
|
207
210
|
this.state = RoomState.Connected;
|
211
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
208
212
|
const pi = joinResponse.participant!;
|
209
213
|
this.localParticipant = new LocalParticipant(
|
210
214
|
pi.sid,
|
@@ -216,10 +220,10 @@ class Room extends EventEmitter {
|
|
216
220
|
this.localParticipant.updateInfo(pi);
|
217
221
|
// forward metadata changed for the local participant
|
218
222
|
this.localParticipant
|
219
|
-
.on(ParticipantEvent.MetadataChanged, (metadata:
|
223
|
+
.on(ParticipantEvent.MetadataChanged, (metadata: string | undefined) => {
|
220
224
|
this.emit(RoomEvent.MetadataChanged, metadata, this.localParticipant);
|
221
225
|
})
|
222
|
-
.on(ParticipantEvent.ParticipantMetadataChanged, (metadata:
|
226
|
+
.on(ParticipantEvent.ParticipantMetadataChanged, (metadata: string | undefined) => {
|
223
227
|
this.emit(RoomEvent.ParticipantMetadataChanged, metadata, this.localParticipant);
|
224
228
|
})
|
225
229
|
.on(ParticipantEvent.TrackMuted, (pub: TrackPublication) => {
|
@@ -445,6 +449,7 @@ class Room extends EventEmitter {
|
|
445
449
|
private handleRestarting = () => {
|
446
450
|
this.state = RoomState.Reconnecting;
|
447
451
|
this.emit(RoomEvent.Reconnecting);
|
452
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
448
453
|
|
449
454
|
// also unwind existing participants & existing subscriptions
|
450
455
|
for (const p of this.participants.values()) {
|
@@ -455,6 +460,7 @@ class Room extends EventEmitter {
|
|
455
460
|
private handleRestarted = async (joinResponse: JoinResponse) => {
|
456
461
|
this.state = RoomState.Connected;
|
457
462
|
this.emit(RoomEvent.Reconnected);
|
463
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
458
464
|
|
459
465
|
// rehydrate participants
|
460
466
|
if (joinResponse.participant) {
|
@@ -509,6 +515,7 @@ class Room extends EventEmitter {
|
|
509
515
|
navigator.mediaDevices.removeEventListener('devicechange', this.handleDeviceChange);
|
510
516
|
this.state = RoomState.Disconnected;
|
511
517
|
this.emit(RoomEvent.Disconnected);
|
518
|
+
this.emit(RoomEvent.StateChanged, this.state);
|
512
519
|
}
|
513
520
|
|
514
521
|
private handleParticipantUpdates = (participantInfos: ParticipantInfo[]) => {
|
@@ -717,66 +724,72 @@ class Room extends EventEmitter {
|
|
717
724
|
}
|
718
725
|
}
|
719
726
|
|
727
|
+
private createParticipant(id: string, info?: ParticipantInfo): RemoteParticipant {
|
728
|
+
let participant: RemoteParticipant;
|
729
|
+
if (info) {
|
730
|
+
participant = RemoteParticipant.fromParticipantInfo(
|
731
|
+
this.engine.client,
|
732
|
+
info,
|
733
|
+
);
|
734
|
+
} else {
|
735
|
+
participant = new RemoteParticipant(this.engine.client, id, '');
|
736
|
+
}
|
737
|
+
return participant;
|
738
|
+
}
|
739
|
+
|
720
740
|
private getOrCreateParticipant(
|
721
741
|
id: string,
|
722
742
|
info?: ParticipantInfo,
|
723
743
|
): RemoteParticipant {
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
730
|
-
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
(track
|
747
|
-
// monitor playback status
|
748
|
-
if (track.kind === Track.Kind.Audio) {
|
749
|
-
track.on(TrackEvent.AudioPlaybackStarted, this.handleAudioPlaybackStarted);
|
750
|
-
track.on(TrackEvent.AudioPlaybackFailed, this.handleAudioPlaybackFailed);
|
751
|
-
}
|
752
|
-
this.emit(RoomEvent.TrackSubscribed, track, publication, participant);
|
753
|
-
})
|
754
|
-
.on(ParticipantEvent.TrackUnpublished, (publication: RemoteTrackPublication) => {
|
755
|
-
this.emit(RoomEvent.TrackUnpublished, publication, participant);
|
756
|
-
})
|
757
|
-
.on(ParticipantEvent.TrackUnsubscribed,
|
758
|
-
(track: RemoteTrack, publication: RemoteTrackPublication) => {
|
759
|
-
this.emit(RoomEvent.TrackUnsubscribed, track, publication, participant);
|
760
|
-
})
|
761
|
-
.on(ParticipantEvent.TrackSubscriptionFailed, (sid: string) => {
|
762
|
-
this.emit(RoomEvent.TrackSubscriptionFailed, sid, participant);
|
763
|
-
})
|
764
|
-
.on(ParticipantEvent.TrackMuted, (pub: TrackPublication) => {
|
765
|
-
this.emit(RoomEvent.TrackMuted, pub, participant);
|
766
|
-
})
|
767
|
-
.on(ParticipantEvent.TrackUnmuted, (pub: TrackPublication) => {
|
768
|
-
this.emit(RoomEvent.TrackUnmuted, pub, participant);
|
769
|
-
})
|
770
|
-
.on(ParticipantEvent.MetadataChanged, (metadata: any) => {
|
771
|
-
this.emit(RoomEvent.MetadataChanged, metadata, participant);
|
744
|
+
if (this.participants.has(id)) {
|
745
|
+
return (this.participants.get(id) as RemoteParticipant);
|
746
|
+
}
|
747
|
+
// it's possible for the RTC track to arrive before signaling data
|
748
|
+
// when this happens, we'll create the participant and make the track work
|
749
|
+
const participant = this.createParticipant(id, info);
|
750
|
+
this.participants.set(id, participant);
|
751
|
+
|
752
|
+
// also forward events
|
753
|
+
// trackPublished is only fired for tracks added after both local participant
|
754
|
+
// and remote participant joined the room
|
755
|
+
participant
|
756
|
+
.on(ParticipantEvent.TrackPublished, (trackPublication: RemoteTrackPublication) => {
|
757
|
+
this.emit(RoomEvent.TrackPublished, trackPublication, participant);
|
758
|
+
})
|
759
|
+
.on(ParticipantEvent.TrackSubscribed,
|
760
|
+
(track: RemoteTrack, publication: RemoteTrackPublication) => {
|
761
|
+
// monitor playback status
|
762
|
+
if (track.kind === Track.Kind.Audio) {
|
763
|
+
track.on(TrackEvent.AudioPlaybackStarted, this.handleAudioPlaybackStarted);
|
764
|
+
track.on(TrackEvent.AudioPlaybackFailed, this.handleAudioPlaybackFailed);
|
765
|
+
}
|
766
|
+
this.emit(RoomEvent.TrackSubscribed, track, publication, participant);
|
772
767
|
})
|
773
|
-
|
774
|
-
|
768
|
+
.on(ParticipantEvent.TrackUnpublished, (publication: RemoteTrackPublication) => {
|
769
|
+
this.emit(RoomEvent.TrackUnpublished, publication, participant);
|
770
|
+
})
|
771
|
+
.on(ParticipantEvent.TrackUnsubscribed,
|
772
|
+
(track: RemoteTrack, publication: RemoteTrackPublication) => {
|
773
|
+
this.emit(RoomEvent.TrackUnsubscribed, track, publication, participant);
|
775
774
|
})
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
775
|
+
.on(ParticipantEvent.TrackSubscriptionFailed, (sid: string) => {
|
776
|
+
this.emit(RoomEvent.TrackSubscriptionFailed, sid, participant);
|
777
|
+
})
|
778
|
+
.on(ParticipantEvent.TrackMuted, (pub: TrackPublication) => {
|
779
|
+
this.emit(RoomEvent.TrackMuted, pub, participant);
|
780
|
+
})
|
781
|
+
.on(ParticipantEvent.TrackUnmuted, (pub: TrackPublication) => {
|
782
|
+
this.emit(RoomEvent.TrackUnmuted, pub, participant);
|
783
|
+
})
|
784
|
+
.on(ParticipantEvent.MetadataChanged, (metadata: string | undefined) => {
|
785
|
+
this.emit(RoomEvent.MetadataChanged, metadata, participant);
|
786
|
+
})
|
787
|
+
.on(ParticipantEvent.ParticipantMetadataChanged, (metadata: string | undefined) => {
|
788
|
+
this.emit(RoomEvent.ParticipantMetadataChanged, metadata, participant);
|
789
|
+
})
|
790
|
+
.on(ParticipantEvent.ConnectionQualityChanged, (quality: ConnectionQuality) => {
|
791
|
+
this.emit(RoomEvent.ConnectionQualityChanged, quality, participant);
|
792
|
+
});
|
780
793
|
return participant;
|
781
794
|
}
|
782
795
|
|
@@ -830,11 +843,74 @@ class Room extends EventEmitter {
|
|
830
843
|
}
|
831
844
|
}
|
832
845
|
|
833
|
-
/** @internal */
|
834
|
-
emit
|
846
|
+
// /** @internal */
|
847
|
+
emit<E extends keyof RoomEventCallbacks>(
|
848
|
+
event: E, ...args: Parameters<RoomEventCallbacks[E]>
|
849
|
+
): boolean {
|
835
850
|
log.debug('room event', event, ...args);
|
836
851
|
return super.emit(event, ...args);
|
837
852
|
}
|
838
853
|
}
|
839
854
|
|
840
855
|
export default Room;
|
856
|
+
|
857
|
+
export type RoomEventCallbacks = {
|
858
|
+
reconnecting: () => void,
|
859
|
+
reconnected: () => void,
|
860
|
+
disconnected: () => void,
|
861
|
+
stateChanged: (state: RoomState) => void,
|
862
|
+
mediaDevicesChanged: () => void,
|
863
|
+
participantConnected: (participant: RemoteParticipant) => void,
|
864
|
+
participantDisconnected: (participant: RemoteParticipant) => void,
|
865
|
+
trackPublished: (publication: RemoteTrackPublication, participant: RemoteParticipant) => void,
|
866
|
+
trackSubscribed: (
|
867
|
+
track: RemoteTrack,
|
868
|
+
publication: RemoteTrackPublication,
|
869
|
+
participant: RemoteParticipant
|
870
|
+
) => void,
|
871
|
+
trackSubscriptionFailed: (trackSid: string, participant: RemoteParticipant) => void,
|
872
|
+
trackUnpublished: (publication: RemoteTrackPublication, participant: RemoteParticipant) => void,
|
873
|
+
trackUnsubscribed: (
|
874
|
+
track: RemoteTrack,
|
875
|
+
publication: RemoteTrackPublication,
|
876
|
+
participant: RemoteParticipant,
|
877
|
+
) => void,
|
878
|
+
trackMuted: (publication: TrackPublication, participant: Participant) => void,
|
879
|
+
trackUnmuted: (publication: TrackPublication, participant: Participant) => void,
|
880
|
+
localTrackPublished: (publication: LocalTrackPublication, participant: LocalParticipant) => void,
|
881
|
+
localTrackUnpublished: (
|
882
|
+
publication: LocalTrackPublication,
|
883
|
+
participant: LocalParticipant
|
884
|
+
) => void,
|
885
|
+
/**
|
886
|
+
* @deprecated use [[participantMetadataChanged]] instead
|
887
|
+
*/
|
888
|
+
metadataChanged: (
|
889
|
+
metadata: string | undefined,
|
890
|
+
participant?: RemoteParticipant | LocalParticipant
|
891
|
+
) => void,
|
892
|
+
participantMetadataChanged: (
|
893
|
+
metadata: string | undefined,
|
894
|
+
participant: RemoteParticipant | LocalParticipant
|
895
|
+
) => void,
|
896
|
+
activeSpeakersChanged: (speakers: Array<Participant>) => void,
|
897
|
+
roomMetadataChanged: (metadata: string) => void,
|
898
|
+
dataReceived: (
|
899
|
+
payload: Uint8Array,
|
900
|
+
participant?: RemoteParticipant,
|
901
|
+
kind?: DataPacket_Kind
|
902
|
+
) => void,
|
903
|
+
connectionQualityChanged: (quality: ConnectionQuality, participant: Participant) => void,
|
904
|
+
mediaDevicesError: (error: Error) => void,
|
905
|
+
trackStreamStateChanged: (
|
906
|
+
publication: RemoteTrackPublication,
|
907
|
+
streamState: Track.StreamState,
|
908
|
+
participant: RemoteParticipant,
|
909
|
+
) => void,
|
910
|
+
trackSubscriptionPermissionChanged: (
|
911
|
+
publication: RemoteTrackPublication,
|
912
|
+
status: TrackPublication.SubscriptionStatus,
|
913
|
+
participant: RemoteParticipant,
|
914
|
+
) => void,
|
915
|
+
audioPlaybackChanged: (playing: boolean) => void,
|
916
|
+
};
|
package/src/room/events.ts
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
* room.on(RoomEvent.TrackPublished, (track, publication, participant) => {})
|
8
8
|
* ```
|
9
9
|
*/
|
10
|
+
|
10
11
|
export enum RoomEvent {
|
11
12
|
/**
|
12
13
|
* When the connection to the server has been interrupted and it's attempting
|
@@ -25,6 +26,13 @@ export enum RoomEvent {
|
|
25
26
|
*/
|
26
27
|
Disconnected = 'disconnected',
|
27
28
|
|
29
|
+
/**
|
30
|
+
* Whenever the connection state of the room changes
|
31
|
+
*
|
32
|
+
* args: ([[RoomState]])
|
33
|
+
*/
|
34
|
+
StateChanged = 'stateChanged',
|
35
|
+
|
28
36
|
/**
|
29
37
|
* When input or output devices on the machine have changed.
|
30
38
|
*/
|
@@ -146,7 +154,7 @@ export enum RoomEvent {
|
|
146
154
|
* args: (prevMetadata: string, [[Participant]])
|
147
155
|
*
|
148
156
|
*/
|
149
|
-
ParticipantMetadataChanged = '
|
157
|
+
ParticipantMetadataChanged = 'participantMetadataChanged',
|
150
158
|
|
151
159
|
/**
|
152
160
|
* Room metadata is a simple way for app-specific state to be pushed to
|
@@ -366,6 +374,7 @@ export enum ParticipantEvent {
|
|
366
374
|
|
367
375
|
/** @internal */
|
368
376
|
export enum EngineEvent {
|
377
|
+
TransportsCreated = 'transportsCreated',
|
369
378
|
Connected = 'connected',
|
370
379
|
Disconnected = 'disconnected',
|
371
380
|
Resuming = 'resuming',
|
@@ -416,8 +416,7 @@ export default class LocalParticipant extends Participant {
|
|
416
416
|
// store RTPSender
|
417
417
|
track.sender = transceiver.sender;
|
418
418
|
if (track instanceof LocalVideoTrack) {
|
419
|
-
|
420
|
-
track.startMonitor(this.engine.client, disableLayerPause);
|
419
|
+
track.startMonitor(this.engine.client);
|
421
420
|
} else if (track instanceof LocalAudioTrack) {
|
422
421
|
track.startMonitor();
|
423
422
|
}
|
@@ -1,8 +1,12 @@
|
|
1
1
|
import { EventEmitter } from 'events';
|
2
|
-
import
|
2
|
+
import type TypedEmitter from 'typed-emitter';
|
3
|
+
import { ConnectionQuality as ProtoQuality, DataPacket_Kind, ParticipantInfo } from '../../proto/livekit_models';
|
3
4
|
import { ParticipantEvent, TrackEvent } from '../events';
|
5
|
+
import LocalTrackPublication from '../track/LocalTrackPublication';
|
6
|
+
import RemoteTrackPublication from '../track/RemoteTrackPublication';
|
4
7
|
import { Track } from '../track/Track';
|
5
8
|
import { TrackPublication } from '../track/TrackPublication';
|
9
|
+
import { RemoteTrack } from '../track/types';
|
6
10
|
|
7
11
|
export enum ConnectionQuality {
|
8
12
|
Excellent = 'excellent',
|
@@ -24,7 +28,9 @@ function qualityFromProto(q: ProtoQuality): ConnectionQuality {
|
|
24
28
|
}
|
25
29
|
}
|
26
30
|
|
27
|
-
export default class Participant extends
|
31
|
+
export default class Participant extends (
|
32
|
+
EventEmitter as new () => TypedEmitter<ParticipantEventCallbacks>
|
33
|
+
) {
|
28
34
|
protected participantInfo?: ParticipantInfo;
|
29
35
|
|
30
36
|
audioTracks: Map<string, TrackPublication>;
|
@@ -158,8 +164,8 @@ export default class Participant extends EventEmitter {
|
|
158
164
|
this.metadata = md;
|
159
165
|
|
160
166
|
if (changed) {
|
161
|
-
this.emit(ParticipantEvent.MetadataChanged, prevMetadata
|
162
|
-
this.emit(ParticipantEvent.ParticipantMetadataChanged, prevMetadata
|
167
|
+
this.emit(ParticipantEvent.MetadataChanged, prevMetadata);
|
168
|
+
this.emit(ParticipantEvent.ParticipantMetadataChanged, prevMetadata);
|
163
169
|
}
|
164
170
|
}
|
165
171
|
|
@@ -212,3 +218,32 @@ export default class Participant extends EventEmitter {
|
|
212
218
|
}
|
213
219
|
}
|
214
220
|
}
|
221
|
+
|
222
|
+
export type ParticipantEventCallbacks = {
|
223
|
+
trackPublished: (publication: RemoteTrackPublication) => void,
|
224
|
+
trackSubscribed: (track: RemoteTrack, publication: RemoteTrackPublication) => void,
|
225
|
+
trackSubscriptionFailed: (trackSid: string) => void,
|
226
|
+
trackUnpublished: (publication: RemoteTrackPublication) => void,
|
227
|
+
trackUnsubscribed: (track: RemoteTrack, publication: RemoteTrackPublication) => void,
|
228
|
+
trackMuted: (publication: TrackPublication) => void,
|
229
|
+
trackUnmuted: (publication: TrackPublication) => void,
|
230
|
+
localTrackPublished: (publication: LocalTrackPublication) => void,
|
231
|
+
localTrackUnpublished: (publication: LocalTrackPublication) => void,
|
232
|
+
/**
|
233
|
+
* @deprecated use [[participantMetadataChanged]] instead
|
234
|
+
*/
|
235
|
+
metadataChanged: (prevMetadata: string | undefined, participant?: any) => void,
|
236
|
+
participantMetadataChanged: (prevMetadata: string | undefined, participant?: any) => void,
|
237
|
+
dataReceived: (payload: Uint8Array, kind: DataPacket_Kind) => void,
|
238
|
+
isSpeakingChanged: (speaking: boolean) => void,
|
239
|
+
connectionQualityChanged: (connectionQuality: ConnectionQuality) => void,
|
240
|
+
trackStreamStateChanged: (
|
241
|
+
publication: RemoteTrackPublication,
|
242
|
+
streamState: Track.StreamState
|
243
|
+
) => void,
|
244
|
+
trackSubscriptionPermissionChanged: (
|
245
|
+
publication: RemoteTrackPublication,
|
246
|
+
status: TrackPublication.SubscriptionStatus
|
247
|
+
) => void,
|
248
|
+
mediaDevicesError: (error: Error) => void,
|
249
|
+
};
|
@@ -10,9 +10,8 @@ import RemoteAudioTrack from '../track/RemoteAudioTrack';
|
|
10
10
|
import RemoteTrackPublication from '../track/RemoteTrackPublication';
|
11
11
|
import RemoteVideoTrack from '../track/RemoteVideoTrack';
|
12
12
|
import { Track } from '../track/Track';
|
13
|
-
import { TrackPublication } from '../track/TrackPublication';
|
14
13
|
import { RemoteTrack } from '../track/types';
|
15
|
-
import Participant from './Participant';
|
14
|
+
import Participant, { ParticipantEventCallbacks } from './Participant';
|
16
15
|
|
17
16
|
export default class RemoteParticipant extends Participant {
|
18
17
|
audioTracks: Map<string, RemoteTrackPublication>;
|
@@ -42,7 +41,7 @@ export default class RemoteParticipant extends Participant {
|
|
42
41
|
this.videoTracks = new Map();
|
43
42
|
}
|
44
43
|
|
45
|
-
protected addTrackPublication(publication:
|
44
|
+
protected addTrackPublication(publication: RemoteTrackPublication) {
|
46
45
|
super.addTrackPublication(publication);
|
47
46
|
|
48
47
|
// register action events
|
@@ -234,7 +233,10 @@ export default class RemoteParticipant extends Participant {
|
|
234
233
|
}
|
235
234
|
|
236
235
|
/** @internal */
|
237
|
-
emit
|
236
|
+
emit<E extends keyof ParticipantEventCallbacks>(
|
237
|
+
event: E,
|
238
|
+
...args: Parameters<ParticipantEventCallbacks[E]>
|
239
|
+
): boolean {
|
238
240
|
log.trace('participant event', this.sid, event, ...args);
|
239
241
|
return super.emit(event, ...args);
|
240
242
|
}
|
@@ -73,7 +73,14 @@ export default class LocalAudioTrack extends LocalTrack {
|
|
73
73
|
this._currentBitrate = 0;
|
74
74
|
return;
|
75
75
|
}
|
76
|
-
|
76
|
+
|
77
|
+
let stats: AudioSenderStats | undefined;
|
78
|
+
try {
|
79
|
+
stats = await this.getSenderStats();
|
80
|
+
} catch (e) {
|
81
|
+
log.error('could not get audio sender stats', e);
|
82
|
+
return;
|
83
|
+
}
|
77
84
|
|
78
85
|
if (stats && this.prevStats) {
|
79
86
|
this._currentBitrate = computeBitrate(stats, this.prevStats);
|
@@ -9,31 +9,14 @@ import { VideoCaptureOptions } from './options';
|
|
9
9
|
import { Track } from './Track';
|
10
10
|
import { constraintsForOptions } from './utils';
|
11
11
|
|
12
|
-
// delay before attempting to upgrade
|
13
|
-
const QUALITY_UPGRADE_DELAY = 60 * 1000;
|
14
|
-
|
15
|
-
// avoid downgrading too quickly
|
16
|
-
const QUALITY_DOWNGRADE_DELAY = 5 * 1000;
|
17
|
-
|
18
|
-
const ridOrder = ['q', 'h', 'f'];
|
19
|
-
|
20
12
|
export default class LocalVideoTrack extends LocalTrack {
|
21
13
|
/* internal */
|
22
14
|
signalClient?: SignalClient;
|
23
15
|
|
24
16
|
private prevStats?: Map<string, VideoSenderStats>;
|
25
17
|
|
26
|
-
// last time it had a change in quality
|
27
|
-
private lastQualityChange?: number;
|
28
|
-
|
29
|
-
// last time we made an explicit change
|
30
|
-
private lastExplicitQualityChange?: number;
|
31
|
-
|
32
18
|
private encodings?: RTCRtpEncodingParameters[];
|
33
19
|
|
34
|
-
// layers that are being subscribed to, and that we should publish
|
35
|
-
private activeQualities?: SubscribedQuality[];
|
36
|
-
|
37
20
|
constructor(
|
38
21
|
mediaTrack: MediaStreamTrack,
|
39
22
|
constraints?: MediaTrackConstraints,
|
@@ -49,7 +32,7 @@ export default class LocalVideoTrack extends LocalTrack {
|
|
49
32
|
}
|
50
33
|
|
51
34
|
/* @internal */
|
52
|
-
startMonitor(signalClient: SignalClient
|
35
|
+
startMonitor(signalClient: SignalClient) {
|
53
36
|
this.signalClient = signalClient;
|
54
37
|
// save original encodings
|
55
38
|
const params = this.sender?.getParameters();
|
@@ -58,7 +41,7 @@ export default class LocalVideoTrack extends LocalTrack {
|
|
58
41
|
}
|
59
42
|
|
60
43
|
setTimeout(() => {
|
61
|
-
this.monitorSender(
|
44
|
+
this.monitorSender();
|
62
45
|
}, monitorFrequency);
|
63
46
|
}
|
64
47
|
|
@@ -186,7 +169,6 @@ export default class LocalVideoTrack extends LocalTrack {
|
|
186
169
|
return;
|
187
170
|
}
|
188
171
|
|
189
|
-
this.activeQualities = qualities;
|
190
172
|
let hasChanged = false;
|
191
173
|
encodings.forEach((encoding, idx) => {
|
192
174
|
let rid = encoding.rid ?? '';
|
@@ -227,17 +209,20 @@ export default class LocalVideoTrack extends LocalTrack {
|
|
227
209
|
}
|
228
210
|
}
|
229
211
|
|
230
|
-
private monitorSender = async (
|
212
|
+
private monitorSender = async () => {
|
231
213
|
if (!this.sender) {
|
232
214
|
this._currentBitrate = 0;
|
233
215
|
return;
|
234
216
|
}
|
235
|
-
const stats = await this.getSenderStats();
|
236
|
-
const statsMap = new Map<string, VideoSenderStats>(stats.map((s) => [s.rid, s]));
|
237
217
|
|
238
|
-
|
239
|
-
|
218
|
+
let stats: VideoSenderStats[] | undefined;
|
219
|
+
try {
|
220
|
+
stats = await this.getSenderStats();
|
221
|
+
} catch (e) {
|
222
|
+
log.error('could not get audio sender stats', e);
|
223
|
+
return;
|
240
224
|
}
|
225
|
+
const statsMap = new Map<string, VideoSenderStats>(stats.map((s) => [s.rid, s]));
|
241
226
|
|
242
227
|
if (this.prevStats) {
|
243
228
|
let totalBitrate = 0;
|
@@ -250,125 +235,9 @@ export default class LocalVideoTrack extends LocalTrack {
|
|
250
235
|
|
251
236
|
this.prevStats = statsMap;
|
252
237
|
setTimeout(() => {
|
253
|
-
this.monitorSender(
|
238
|
+
this.monitorSender();
|
254
239
|
}, monitorFrequency);
|
255
240
|
};
|
256
|
-
|
257
|
-
private checkAndUpdateSimulcast(statsMap: Map<string, VideoSenderStats>) {
|
258
|
-
if (!this.sender || this.isMuted || !this.encodings) {
|
259
|
-
return;
|
260
|
-
}
|
261
|
-
|
262
|
-
let bestEncoding: RTCRtpEncodingParameters | undefined;
|
263
|
-
const { encodings } = this.sender.getParameters();
|
264
|
-
encodings.forEach((encoding) => {
|
265
|
-
// skip inactive encodings
|
266
|
-
if (!encoding.active) return;
|
267
|
-
|
268
|
-
if (bestEncoding === undefined) {
|
269
|
-
bestEncoding = encoding;
|
270
|
-
} else if (
|
271
|
-
bestEncoding.rid
|
272
|
-
&& encoding.rid
|
273
|
-
&& ridOrder.indexOf(bestEncoding.rid) < ridOrder.indexOf(encoding.rid)
|
274
|
-
) {
|
275
|
-
bestEncoding = encoding;
|
276
|
-
} else if (
|
277
|
-
bestEncoding.maxBitrate !== undefined
|
278
|
-
&& encoding.maxBitrate !== undefined
|
279
|
-
&& bestEncoding.maxBitrate < encoding.maxBitrate
|
280
|
-
) {
|
281
|
-
bestEncoding = encoding;
|
282
|
-
}
|
283
|
-
});
|
284
|
-
|
285
|
-
if (!bestEncoding) {
|
286
|
-
return;
|
287
|
-
}
|
288
|
-
const rid: string = bestEncoding.rid ?? '';
|
289
|
-
const sendStats = statsMap.get(rid);
|
290
|
-
const lastStats = this.prevStats?.get(rid);
|
291
|
-
if (!sendStats || !lastStats) {
|
292
|
-
return;
|
293
|
-
}
|
294
|
-
const currentQuality = videoQualityForRid(rid);
|
295
|
-
|
296
|
-
// adaptive simulcast algorithm notes (davidzhao)
|
297
|
-
// Chrome (and other browsers) will automatically pause the highest layer
|
298
|
-
// when it runs into bandwidth limitations. When that happens, it would not
|
299
|
-
// be able to send any new frames between the two stats checks.
|
300
|
-
//
|
301
|
-
// We need to set that layer to inactive intentionally, because chrome tends
|
302
|
-
// to flicker, meaning it will attempt to send that layer again shortly
|
303
|
-
// afterwards, flip-flopping every few seconds. We want to avoid that.
|
304
|
-
//
|
305
|
-
// Note: even after bandwidth recovers, the flip-flopping behavior continues
|
306
|
-
// this is possibly due to SFU-side PLI generation and imperfect bandwidth estimation
|
307
|
-
if (sendStats.qualityLimitationResolutionChanges
|
308
|
-
- lastStats.qualityLimitationResolutionChanges > 0) {
|
309
|
-
this.lastQualityChange = new Date().getTime();
|
310
|
-
}
|
311
|
-
|
312
|
-
// log.debug('frameSent', sendStats.framesSent, 'lastSent', lastStats.framesSent,
|
313
|
-
// 'elapsed', sendStats.timestamp - lastStats.timestamp);
|
314
|
-
if (sendStats.framesSent - lastStats.framesSent > 0) {
|
315
|
-
// frames have been sending ok, consider upgrading quality
|
316
|
-
if (currentQuality === VideoQuality.HIGH || !this.lastQualityChange) return;
|
317
|
-
|
318
|
-
const nextQuality = currentQuality + 1;
|
319
|
-
if ((new Date()).getTime() - this.lastQualityChange < QUALITY_UPGRADE_DELAY) {
|
320
|
-
return;
|
321
|
-
}
|
322
|
-
|
323
|
-
if (this.activeQualities
|
324
|
-
&& this.activeQualities.some((q) => q.quality === nextQuality && !q.enabled)
|
325
|
-
) {
|
326
|
-
// quality has been disabled by the server, so we should skip
|
327
|
-
return;
|
328
|
-
}
|
329
|
-
|
330
|
-
// we are already at the highest layer
|
331
|
-
let bestQuality = VideoQuality.LOW;
|
332
|
-
encodings.forEach((encoding) => {
|
333
|
-
const quality = videoQualityForRid(encoding.rid ?? '');
|
334
|
-
if (quality > bestQuality) {
|
335
|
-
bestQuality = quality;
|
336
|
-
}
|
337
|
-
});
|
338
|
-
if (nextQuality > bestQuality) {
|
339
|
-
return;
|
340
|
-
}
|
341
|
-
|
342
|
-
log.debug('upgrading video quality to', nextQuality);
|
343
|
-
this.setPublishingQuality(nextQuality);
|
344
|
-
return;
|
345
|
-
}
|
346
|
-
|
347
|
-
// if best layer has not sent anything, do not downgrade till the
|
348
|
-
// best layer starts sending something. It is possible that the
|
349
|
-
// browser has not started some layer(s) due to cpu/bandwidth
|
350
|
-
// constraints
|
351
|
-
if (sendStats.framesSent === 0) return;
|
352
|
-
|
353
|
-
// if we've upgraded or downgraded recently, give it a bit of time before
|
354
|
-
// downgrading again
|
355
|
-
if (this.lastExplicitQualityChange
|
356
|
-
&& ((new Date()).getTime() - this.lastExplicitQualityChange) < QUALITY_DOWNGRADE_DELAY) {
|
357
|
-
return;
|
358
|
-
}
|
359
|
-
|
360
|
-
if (currentQuality === VideoQuality.UNRECOGNIZED) {
|
361
|
-
return;
|
362
|
-
}
|
363
|
-
|
364
|
-
if (currentQuality === VideoQuality.LOW) {
|
365
|
-
// already the lowest quality, nothing we can do
|
366
|
-
return;
|
367
|
-
}
|
368
|
-
|
369
|
-
log.debug('downgrading video quality to', currentQuality - 1);
|
370
|
-
this.setPublishingQuality(currentQuality - 1);
|
371
|
-
}
|
372
241
|
}
|
373
242
|
|
374
243
|
export function videoQualityForRid(rid: string): VideoQuality {
|