Participant.kt
11.2 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
package io.livekit.android.room.participant
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.events.BroadcastEventBus
import io.livekit.android.events.ParticipantEvent
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.flow
import io.livekit.android.util.flowDelegate
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.stateIn
import livekit.LivekitModels
import javax.inject.Named
open class Participant(
var sid: String,
identity: String? = null,
@Named(InjectionNames.DISPATCHER_DEFAULT)
coroutineDispatcher: CoroutineDispatcher,
) {
protected val scope = 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
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var identity: String? by flowDelegate(identity)
internal set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var audioLevel: Float by flowDelegate(0f)
internal set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var isSpeaking: Boolean by flowDelegate(false) { newValue, oldValue ->
if (newValue != oldValue) {
listener?.onSpeakingChanged(this)
internalListener?.onSpeakingChanged(this)
eventBus.postEvent(ParticipantEvent.SpeakingChanged(this, newValue), scope)
}
}
internal set
@FlowObservable
@get:FlowObservable
var name by flowDelegate<String?>(null)
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var metadata: String? by flowDelegate(null) { newMetadata, oldMetadata ->
if (newMetadata != oldMetadata) {
listener?.onMetadataChanged(this, oldMetadata)
internalListener?.onMetadataChanged(this, oldMetadata)
eventBus.postEvent(ParticipantEvent.MetadataChanged(this, oldMetadata), 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
/**
* Listener for when participant properties change
*/
@Deprecated("Use events instead")
var listener: ParticipantListener? = null
/**
* @suppress
*/
@Deprecated("Use events instead")
internal var internalListener: ParticipantListener? = null
val hasInfo
get() = participantInfo != null
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
var tracks by flowDelegate(emptyMap<String, TrackPublication>())
protected set
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
val audioTracks by flowDelegate(
stateFlow = ::tracks.flow
.map { it.filterValues { publication -> publication.kind == Track.Kind.AUDIO } }
.stateIn(scope, SharingStarted.Eagerly, emptyMap())
)
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
val videoTracks by flowDelegate(
stateFlow = ::tracks.flow
.map {
it.filterValues { publication -> publication.kind == Track.Kind.VIDEO }
}
.stateIn(scope, SharingStarted.Eagerly, emptyMap())
)
/**
* @suppress
*/
fun addTrackPublication(publication: TrackPublication) {
val track = publication.track
track?.sid = publication.sid
tracks = tracks.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 tracks) {
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 tracks) {
if (pub.name == name) {
return pub
}
}
return null
}
fun isCameraEnabled(): Boolean {
val pub = getTrackPublication(Track.Source.CAMERA)
return isTrackPublicationEnabled(pub)
}
fun isMicrophoneEnabled(): Boolean {
val pub = getTrackPublication(Track.Source.MICROPHONE)
return isTrackPublicationEnabled(pub)
}
fun isScreenShareEnabled(): Boolean {
val pub = getTrackPublication(Track.Source.SCREEN_SHARE)
return isTrackPublicationEnabled(pub)
}
private fun isTrackPublicationEnabled(pub: TrackPublication?): Boolean {
return !(pub?.muted ?: true)
}
/**
* @suppress
*/
internal open fun updateFromInfo(info: LivekitModels.ParticipantInfo) {
sid = info.sid
identity = info.identity
participantInfo = info
metadata = info.metadata
name = info.name
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as Participant
if (sid != other.sid) return false
return true
}
override fun hashCode(): Int {
return sid.hashCode()
}
// Internal methods just for posting events.
internal fun onTrackMuted(trackPublication: TrackPublication) {
listener?.onTrackMuted(trackPublication, this)
internalListener?.onTrackMuted(trackPublication, this)
eventBus.postEvent(ParticipantEvent.TrackMuted(this, trackPublication), scope)
}
internal fun onTrackUnmuted(trackPublication: TrackPublication) {
listener?.onTrackUnmuted(trackPublication, this)
internalListener?.onTrackUnmuted(trackPublication, this)
eventBus.postEvent(ParticipantEvent.TrackUnmuted(this, trackPublication), scope)
}
internal fun onTrackStreamStateChanged(trackEvent: TrackEvent.StreamStateChanged) {
val trackPublication = tracks[trackEvent.track.sid] ?: return
eventBus.postEvent(
ParticipantEvent.TrackStreamStateChanged(this, trackPublication, trackEvent.streamState),
scope
)
}
}
@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;
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
}
}
}
}