Participant.kt
21.5 KB
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
/*
* Copyright 2023-2025 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.room.participant
import androidx.annotation.VisibleForTesting
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.events.BroadcastEventBus
import io.livekit.android.events.ParticipantEvent
import io.livekit.android.events.RoomEvent
import io.livekit.android.events.TrackEvent
import io.livekit.android.room.track.LocalTrackPublication
import io.livekit.android.room.track.RemoteTrackPublication
import io.livekit.android.room.track.Track
import io.livekit.android.room.track.TrackPublication
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.diffMapChange
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.ExperimentalCoroutinesApi
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.cancel
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.flatMapLatest
import kotlinx.coroutines.flow.flowOf
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.stateIn
import kotlinx.coroutines.isActive
import kotlinx.serialization.Serializable
import livekit.LivekitModels
import java.util.Date
import javax.inject.Named
open class Participant(
var sid: Sid,
identity: Identity? = null,
@Named(InjectionNames.DISPATCHER_DEFAULT)
private val coroutineDispatcher: CoroutineDispatcher,
) {
@Serializable
@JvmInline
value class Identity(val value: String)
@Serializable
@JvmInline
value class Sid(val value: String)
/**
* To only be used for flow delegate scoping, and should not be cancelled.
**/
private val delegateScope = createScope()
protected var scope: CoroutineScope = createScope()
private set
private fun createScope() = CoroutineScope(coroutineDispatcher + SupervisorJob())
protected val eventBus = BroadcastEventBus<ParticipantEvent>()
val events = eventBus.readOnly()
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var participantInfo: LivekitModels.ParticipantInfo? by flowDelegate(null)
private set
/**
* The participant's identity on the server. [name] should be preferred for UI usecases.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var identity: Identity? by flowDelegate(identity)
@VisibleForTesting set
/**
* The participant state.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var state: State by flowDelegate(State.UNKNOWN) { newState, oldState ->
if (newState != oldState) {
eventBus.postEvent(
ParticipantEvent.StateChanged(
participant = this,
newState = newState,
oldState = oldState,
),
scope,
)
}
}
@VisibleForTesting set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var audioLevel: Float by flowDelegate(0f)
@VisibleForTesting set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*
* A [ParticipantEvent.SpeakingChanged] event is emitted from [events] whenever
* this changes.
*/
@FlowObservable
@get:FlowObservable
var isSpeaking: Boolean by flowDelegate(false) { newValue, oldValue ->
if (newValue != oldValue) {
internalListener?.onSpeakingChanged(this)
eventBus.postEvent(ParticipantEvent.SpeakingChanged(this, newValue), scope)
if (newValue) {
lastSpokeAt = Date().time
}
}
}
@VisibleForTesting set
/**
* The participant's name. To be used for user-facing purposes (i.e. when displayed in the UI).
*
* Changes can be observed by using [io.livekit.android.util.flow]
*
* A [ParticipantEvent.NameChanged] event is emitted from [events] whenever
* this changes.
*/
@FlowObservable
@get:FlowObservable
var name by flowDelegate<String?>(null) { newValue, oldValue ->
if (newValue != oldValue) {
eventBus.postEvent(ParticipantEvent.NameChanged(this, newValue), scope)
}
}
@VisibleForTesting set
/**
* The metadata for this participant.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*
* A [ParticipantEvent.MetadataChanged] event is emitted from [events] whenever
* this changes.
*/
@FlowObservable
@get:FlowObservable
var metadata: String? by flowDelegate(null) { newMetadata, oldMetadata ->
if (newMetadata != oldMetadata) {
internalListener?.onMetadataChanged(this, oldMetadata)
eventBus.postEvent(ParticipantEvent.MetadataChanged(this, oldMetadata), scope)
}
}
@VisibleForTesting set
/**
* The attributes set on this participant.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*
* A [ParticipantEvent.AttributesChanged] event is emitted from [events] whenever
* this changes.
*/
@FlowObservable
@get:FlowObservable
var attributes: Map<String, String> by flowDelegate(emptyMap()) { newAttributes, oldAttributes ->
if (newAttributes != oldAttributes) {
val diff = diffMapChange(newAttributes, oldAttributes, "")
if (diff.isNotEmpty()) {
eventBus.postEvent(ParticipantEvent.AttributesChanged(this, diff, oldAttributes), scope)
}
}
}
@VisibleForTesting set
/**
* The permissions for this participant.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*
* A [ParticipantEvent.ParticipantPermissionsChanged] event is emitted from [events] whenever
* this changes.
*/
@FlowObservable
@get:FlowObservable
var permissions: ParticipantPermission? by flowDelegate(null) { newPermissions, oldPermissions ->
if (newPermissions != oldPermissions) {
eventBus.postEvent(
ParticipantEvent.ParticipantPermissionsChanged(
this,
newPermissions,
oldPermissions,
),
scope,
)
}
}
internal set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var connectionQuality by flowDelegate(ConnectionQuality.UNKNOWN)
internal set
/**
* Timestamp when participant joined room, in milliseconds
*/
val joinedAt
get() = participantInfo?.joinedAt?.times(1000)
/**
* Timestamp when the participant last started speaking, in milliseconds
*/
@FlowObservable
@get:FlowObservable
var lastSpokeAt by flowDelegate<Long?>(null)
internal set
/**
* The kind of participant (i.e. a standard client participant, AI agent, etc.)
*/
@FlowObservable
@get:FlowObservable
var kind by flowDelegate(Kind.UNKNOWN)
internal set
/**
* @suppress
*/
@Deprecated("Use events instead")
@VisibleForTesting
var internalListener: ParticipantListener? = null
val hasInfo
get() = participantInfo != null
/**
* Maps track sids to their track publications.
*
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var trackPublications by flowDelegate(emptyMap<String, TrackPublication>())
protected set
@OptIn(ExperimentalCoroutinesApi::class)
private fun Flow<Map<String, TrackPublication>>.trackUpdateFlow(): Flow<List<Pair<TrackPublication, Track?>>> {
return flatMapLatest { videoTracks ->
if (videoTracks.isEmpty()) {
flowOf(emptyList())
} else {
combine(
videoTracks.values
.map { trackPublication ->
// Re-emit when track changes
trackPublication::track.flow
.map { trackPublication to trackPublication.track }
},
) { trackPubs ->
trackPubs.toList()
}
}
}
}
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
val audioTrackPublications by flowDelegate(
stateFlow = ::trackPublications.flow
.map { it.filterValues { publication -> publication.kind == Track.Kind.AUDIO } }
.trackUpdateFlow()
.stateIn(delegateScope, SharingStarted.Eagerly, emptyList()),
)
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
val videoTrackPublications by flowDelegate(
stateFlow = ::trackPublications.flow
.map { it.filterValues { publication -> publication.kind == Track.Kind.VIDEO } }
.trackUpdateFlow()
.stateIn(delegateScope, SharingStarted.Eagerly, emptyList()),
)
/**
* @suppress
*/
fun addTrackPublication(publication: TrackPublication) {
val track = publication.track
track?.sid = publication.sid
trackPublications = trackPublications.toMutableMap().apply {
this[publication.sid] = publication
}
}
/**
* Retrieves the first track that matches the source, or null
*/
open fun getTrackPublication(source: Track.Source): TrackPublication? {
if (source == Track.Source.UNKNOWN) {
return null
}
for ((_, pub) in trackPublications) {
if (pub.source == source) {
return pub
}
// Alternative heuristics for finding track if source is unknown
if (pub.source == Track.Source.UNKNOWN) {
if (source == Track.Source.MICROPHONE && pub.kind == Track.Kind.AUDIO) {
return pub
}
if (source == Track.Source.CAMERA && pub.kind == Track.Kind.VIDEO && pub.name != "screen") {
return pub
}
if (source == Track.Source.SCREEN_SHARE && pub.kind == Track.Kind.VIDEO && pub.name == "screen") {
return pub
}
}
}
return null
}
/**
* Retrieves the first track that matches [name], or null
*/
open fun getTrackPublicationByName(name: String): TrackPublication? {
for ((_, pub) in trackPublications) {
if (pub.name == name) {
return pub
}
}
return null
}
@FlowObservable
@get:FlowObservable
val isMicrophoneEnabled by flowDelegate(
stateFlow = ::audioTrackPublications.flow
.map { it.firstOrNull { (pub, _) -> pub.source == Track.Source.MICROPHONE } ?: (null to null) }
.isTrackEnabledDetector()
.stateIn(delegateScope, SharingStarted.Eagerly, false),
)
@FlowObservable
@get:FlowObservable
val isCameraEnabled by flowDelegate(
stateFlow = ::videoTrackPublications.flow
.map { it.firstOrNull { (pub, _) -> pub.source == Track.Source.CAMERA } ?: (null to null) }
.isTrackEnabledDetector()
.stateIn(delegateScope, SharingStarted.Eagerly, false),
)
@FlowObservable
@get:FlowObservable
val isScreenShareEnabled by flowDelegate(
stateFlow = ::videoTrackPublications.flow
.map { it.firstOrNull { (pub, _) -> pub.source == Track.Source.SCREEN_SHARE } ?: (null to null) }
.isTrackEnabledDetector()
.stateIn(delegateScope, SharingStarted.Eagerly, false),
)
@OptIn(ExperimentalCoroutinesApi::class)
private fun Flow<Pair<TrackPublication?, Track?>>.isTrackEnabledDetector(): Flow<Boolean> {
return this.flatMapLatest { (pub, track) ->
if (pub == null) {
flowOf(false to track)
} else {
pub::muted.flow
.map { muted -> muted to track }
}
}.map { (muted, track) -> (!muted && track != null) }
}
/**
* @suppress
*/
open fun updateFromInfo(info: LivekitModels.ParticipantInfo) {
sid = Sid(info.sid)
identity = Identity(info.identity)
participantInfo = info
metadata = info.metadata
name = info.name
kind = Kind.fromProto(info.kind)
if (info.hasPermission()) {
permissions = ParticipantPermission.fromProto(info.permission)
}
attributes = info.attributesMap
state = State.fromProto(info.state)
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as Participant
return sid == other.sid
}
override fun hashCode(): Int {
return sid.hashCode()
}
// Internal methods just for posting events.
internal fun onTrackMuted(trackPublication: TrackPublication) {
internalListener?.onTrackMuted(trackPublication, this)
eventBus.postEvent(ParticipantEvent.TrackMuted(this, trackPublication), scope)
}
internal fun onTrackUnmuted(trackPublication: TrackPublication) {
internalListener?.onTrackUnmuted(trackPublication, this)
eventBus.postEvent(ParticipantEvent.TrackUnmuted(this, trackPublication), scope)
}
internal fun onTrackStreamStateChanged(trackEvent: TrackEvent.StreamStateChanged) {
val trackPublication = trackPublications[trackEvent.track.sid] ?: return
eventBus.postEvent(
ParticipantEvent.TrackStreamStateChanged(this, trackPublication, trackEvent.streamState),
scope,
)
}
internal fun onTranscriptionReceived(transcription: RoomEvent.TranscriptionReceived) {
if (transcription.participant != this) {
return
}
eventBus.postEvent(
ParticipantEvent.TranscriptionReceived(
this,
transcriptions = transcription.transcriptionSegments,
publication = transcription.publication,
),
scope,
)
}
internal fun reinitialize() {
if (!scope.isActive) {
scope = createScope()
}
}
/**
* @suppress
*/
@VisibleForTesting
open fun dispose() {
scope.cancel()
sid = Sid("")
name = null
identity = null
metadata = null
participantInfo = null
permissions = null
connectionQuality = ConnectionQuality.UNKNOWN
}
enum class Kind {
AGENT,
STANDARD,
INGRESS,
EGRESS,
SIP,
UNKNOWN,
;
companion object {
/**
* @suppress
*/
fun fromProto(proto: LivekitModels.ParticipantInfo.Kind): Kind {
return when (proto) {
LivekitModels.ParticipantInfo.Kind.AGENT -> AGENT
LivekitModels.ParticipantInfo.Kind.STANDARD -> STANDARD
LivekitModels.ParticipantInfo.Kind.INGRESS -> INGRESS
LivekitModels.ParticipantInfo.Kind.EGRESS -> EGRESS
LivekitModels.ParticipantInfo.Kind.SIP -> SIP
LivekitModels.ParticipantInfo.Kind.UNRECOGNIZED -> UNKNOWN
}
}
}
}
enum class State {
// websocket' connected, but not offered yet
JOINING,
// server received client offer
JOINED,
// ICE connectivity established
ACTIVE,
// WS disconnected
DISCONNECTED,
UNKNOWN;
companion object {
fun fromProto(proto: LivekitModels.ParticipantInfo.State): State {
return when (proto) {
LivekitModels.ParticipantInfo.State.JOINING -> JOINING
LivekitModels.ParticipantInfo.State.JOINED -> JOINED
LivekitModels.ParticipantInfo.State.ACTIVE -> ACTIVE
LivekitModels.ParticipantInfo.State.DISCONNECTED -> DISCONNECTED
LivekitModels.ParticipantInfo.State.UNRECOGNIZED -> UNKNOWN
}
}
}
}
}
/**
* @suppress
*/
@Deprecated("Use Participant.events instead.")
interface ParticipantListener {
// all participants
/**
* When a participant's metadata is updated, fired for all participants
*/
fun onMetadataChanged(participant: Participant, prevMetadata: String?) {}
/**
* Fired when the current participant's isSpeaking property changes. (including LocalParticipant)
*/
fun onSpeakingChanged(participant: Participant) {}
/**
* The participant was muted.
*
* For the local participant, the callback will be called if setMute was called on the
* [LocalTrackPublication], or if the server has requested the participant to be muted
*/
fun onTrackMuted(publication: TrackPublication, participant: Participant) {}
/**
* The participant was unmuted.
*
* For the local participant, the callback will be called if setMute was called on the
* [LocalTrackPublication], or if the server has requested the participant to be muted
*/
fun onTrackUnmuted(publication: TrackPublication, participant: Participant) {}
// local participants
/**
* When a new track is published by the local participant.
*/
fun onTrackPublished(publication: LocalTrackPublication, participant: LocalParticipant) {}
/**
* A [LocalParticipant] has unpublished a track
*/
fun onTrackUnpublished(publication: LocalTrackPublication, participant: LocalParticipant) {}
// remote participants
/**
* When a new track is published to room after the local participant has joined.
*
* It will not fire for tracks that are already published
*/
fun onTrackPublished(publication: RemoteTrackPublication, participant: RemoteParticipant) {}
/**
* A [RemoteParticipant] has unpublished a track
*/
fun onTrackUnpublished(publication: RemoteTrackPublication, participant: RemoteParticipant) {}
/**
* Subscribed to a new track
*/
fun onTrackSubscribed(track: Track, publication: RemoteTrackPublication, participant: RemoteParticipant) {}
/**
* Error had occurred while subscribing to a track
*/
fun onTrackSubscriptionFailed(
sid: String,
exception: Exception,
participant: RemoteParticipant,
) {
}
/**
* A subscribed track is no longer available.
* Clients should listen to this event and handle cleanup
*/
fun onTrackUnsubscribed(
track: Track,
publication: RemoteTrackPublication,
participant: RemoteParticipant,
) {
}
/**
* Received data published by another participant
*/
fun onDataReceived(data: ByteArray, participant: RemoteParticipant) {}
}
enum class ConnectionQuality {
EXCELLENT,
GOOD,
POOR,
UNKNOWN,
LOST,
;
companion object {
fun fromProto(proto: LivekitModels.ConnectionQuality): ConnectionQuality {
return when (proto) {
LivekitModels.ConnectionQuality.EXCELLENT -> EXCELLENT
LivekitModels.ConnectionQuality.GOOD -> GOOD
LivekitModels.ConnectionQuality.POOR -> POOR
LivekitModels.ConnectionQuality.UNRECOGNIZED -> UNKNOWN
LivekitModels.ConnectionQuality.LOST -> LOST
}
}
}
}
data class ParticipantPermission(
val canPublish: Boolean,
val canSubscribe: Boolean,
val canPublishData: Boolean,
val hidden: Boolean,
val recorder: Boolean,
/**
* The list of allowed sources. If this is empty, then all sources are allowed.
*/
val canPublishSources: List<Track.Source>,
val canUpdateMetadata: Boolean,
val canSubscribeMetrics: Boolean,
) {
companion object {
fun fromProto(proto: LivekitModels.ParticipantPermission): ParticipantPermission {
return ParticipantPermission(
canPublish = proto.canPublish,
canSubscribe = proto.canSubscribe,
canPublishData = proto.canPublishData,
hidden = proto.hidden,
recorder = proto.recorder,
canPublishSources = proto.canPublishSourcesList.map { Track.Source.fromProto(it) },
canUpdateMetadata = proto.canUpdateMetadata,
canSubscribeMetrics = proto.canSubscribeMetrics,
)
}
}
}