Track.kt
7.3 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
/*
* 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.track
import io.livekit.android.events.BroadcastEventBus
import io.livekit.android.events.TrackEvent
import io.livekit.android.util.flowDelegate
import io.livekit.android.webrtc.RTCStatsGetter
import io.livekit.android.webrtc.getStats
import io.livekit.android.webrtc.peerconnection.executeBlockingOnRTCThread
import livekit.LivekitModels
import livekit.LivekitRtc
import livekit.org.webrtc.MediaStreamTrack
import livekit.org.webrtc.RTCStatsCollectorCallback
import livekit.org.webrtc.RTCStatsReport
import kotlin.contracts.ExperimentalContracts
import kotlin.contracts.InvocationKind
import kotlin.contracts.contract
abstract class Track(
name: String,
kind: Kind,
open val rtcTrack: MediaStreamTrack,
) {
protected val eventBus = BroadcastEventBus<TrackEvent>()
val events = eventBus.readOnly()
var name = name
internal set
var kind = kind
internal set
var sid: String? = null
internal set
var streamState: StreamState by flowDelegate(StreamState.PAUSED) { newValue, oldValue ->
if (newValue != oldValue) {
eventBus.tryPostEvent(TrackEvent.StreamStateChanged(this, newValue))
}
}
internal set
var enabled: Boolean
get() = withRTCTrack(defaultValue = false) { rtcTrack.enabled() }
set(value) = withRTCTrack { rtcTrack.setEnabled(value) }
var statsGetter: RTCStatsGetter? = null
internal val isDisposed
get() = rtcTrack.isDisposed
/**
* Return the [RTCStatsReport] for this track, or null if none is available.
*/
suspend fun getRTCStats(): RTCStatsReport? = statsGetter?.getStats()
/**
* Calls the [callback] with the [RTCStatsReport] for this track, or null if none is available.
*/
fun getRTCStats(callback: RTCStatsCollectorCallback) {
statsGetter?.invoke(callback) ?: callback.onStatsDelivered(null)
}
enum class Kind(val value: String) {
AUDIO("audio"),
VIDEO("video"),
// unknown
UNRECOGNIZED("unrecognized"),
;
fun toProto(): LivekitModels.TrackType {
return when (this) {
AUDIO -> LivekitModels.TrackType.AUDIO
VIDEO -> LivekitModels.TrackType.VIDEO
UNRECOGNIZED -> LivekitModels.TrackType.UNRECOGNIZED
}
}
override fun toString(): String {
return value
}
companion object {
fun fromProto(tt: LivekitModels.TrackType): Kind {
return when (tt) {
LivekitModels.TrackType.AUDIO -> AUDIO
LivekitModels.TrackType.VIDEO -> VIDEO
LivekitModels.TrackType.DATA, // TODO: does this need to be handled?
LivekitModels.TrackType.UNRECOGNIZED,
-> UNRECOGNIZED
}
}
}
}
enum class Source {
UNKNOWN,
CAMERA,
MICROPHONE,
SCREEN_SHARE,
SCREEN_SHARE_AUDIO,
;
fun toProto(): LivekitModels.TrackSource {
return when (this) {
UNKNOWN -> LivekitModels.TrackSource.UNKNOWN
CAMERA -> LivekitModels.TrackSource.CAMERA
MICROPHONE -> LivekitModels.TrackSource.MICROPHONE
SCREEN_SHARE -> LivekitModels.TrackSource.SCREEN_SHARE
SCREEN_SHARE_AUDIO -> LivekitModels.TrackSource.SCREEN_SHARE_AUDIO
}
}
companion object {
fun fromProto(source: LivekitModels.TrackSource): Source {
return when (source) {
LivekitModels.TrackSource.CAMERA -> CAMERA
LivekitModels.TrackSource.MICROPHONE -> MICROPHONE
LivekitModels.TrackSource.SCREEN_SHARE -> SCREEN_SHARE
LivekitModels.TrackSource.SCREEN_SHARE_AUDIO -> SCREEN_SHARE_AUDIO
LivekitModels.TrackSource.UNKNOWN,
LivekitModels.TrackSource.UNRECOGNIZED,
-> UNKNOWN
}
}
}
}
enum class StreamState {
ACTIVE,
PAUSED,
UNKNOWN,
;
fun toProto(): LivekitRtc.StreamState {
return when (this) {
ACTIVE -> LivekitRtc.StreamState.ACTIVE
PAUSED -> LivekitRtc.StreamState.PAUSED
UNKNOWN -> LivekitRtc.StreamState.UNRECOGNIZED
}
}
companion object {
fun fromProto(state: LivekitRtc.StreamState): StreamState {
return when (state) {
LivekitRtc.StreamState.ACTIVE -> ACTIVE
LivekitRtc.StreamState.PAUSED -> PAUSED
LivekitRtc.StreamState.UNRECOGNIZED -> UNKNOWN
}
}
}
}
data class Dimensions(val width: Int, val height: Int)
/**
* Starts the track.
*/
open fun start() {
enabled = true
}
/**
* Stops the track.
*/
open fun stop() {
enabled = false
}
/**
* Disposes the track. LiveKit will generally take care of disposing tracks for you.
*/
open fun dispose() {
withRTCTrack {
rtcTrack.dispose()
}
}
@OptIn(ExperimentalContracts::class)
internal inline fun <T> withRTCTrack(crossinline action: MediaStreamTrack.() -> T) {
contract { callsInPlace(action, InvocationKind.AT_MOST_ONCE) }
withRTCTrack(Unit, action)
}
@OptIn(ExperimentalContracts::class)
internal inline fun <T> withRTCTrack(defaultValue: T, crossinline action: MediaStreamTrack.() -> T): T {
contract { callsInPlace(action, InvocationKind.AT_MOST_ONCE) }
if (isDisposed) {
return defaultValue
}
return executeBlockingOnRTCThread {
return@executeBlockingOnRTCThread if (isDisposed) {
defaultValue
} else {
action(rtcTrack)
}
}
}
}
sealed class TrackException(message: String? = null, cause: Throwable? = null) :
Exception(message, cause) {
class InvalidTrackTypeException(message: String? = null, cause: Throwable? = null) :
TrackException(message, cause)
class DuplicateTrackException(message: String? = null, cause: Throwable? = null) :
TrackException(message, cause)
class InvalidTrackStateException(message: String? = null, cause: Throwable? = null) :
TrackException(message, cause)
class MediaException(message: String? = null, cause: Throwable? = null) :
TrackException(message, cause)
class PublishException(message: String? = null, cause: Throwable? = null) :
TrackException(message, cause)
}
const val KIND_AUDIO = "audio"
const val KIND_VIDEO = "video"