Skip to content

feat(server-sdk): SIP Update APIs, Sync mode, Egress audio mixing #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 9, 2025
Merged

feat(server-sdk): SIP Update APIs, Sync mode, Egress audio mixing #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f02acc3
fix(forward-participant): add destinatin room to VideoGrant
anunaym14 Apr 9, 2025
04dc261
feat(egress): add audio mixing
anunaym14 Apr 9, 2025
e891255
chore(docs): add doc for forward participant
anunaym14 Apr 9, 2025
862cd82
feat(sip): update apis
anunaym14 Apr 9, 2025
38dfe7c
chore: spotless
anunaym14 Apr 9, 2025
93c13cf
chore(deps): update protocol
anunaym14 Apr 9, 2025
71957c5
feat(sip): sync mode, cleanup
anunaym14 Apr 9, 2025
e9eb205
chore: changeset
anunaym14 Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/happy-points-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"server-sdk-kotlin": minor
---

SIP Update APIs, Sync mode, Egress audio mixing
2 changes: 1 addition & 1 deletion protocol
Open in desktop
Submodule protocol updated 32 files
+5 −0 .changeset/blue-birds-add.md
+6 −0 .changeset/clever-jars-invent.md
+5 −0 .changeset/pretty-gifts-look.md
+6 −0 .changeset/sip-transfer-timeout.md
+5 −0 .changeset/sip-update-fix.md
+6 −0 .changeset/thirty-cougars-dream.md
+4 −0 auth/grants.go
+15 −5 livekit/livekit_models.pb.go
+2 −3 livekit/livekit_room.twirp.go
+62 −51 livekit/livekit_sip.pb.go
+264 −264 livekit/livekit_sip.twirp.go
+45 −28 livekit/sip.go
+104 −3 livekit/sip_test.go
+4 −0 livekit/types.go
+3 −0 protobufs/livekit_models.proto
+2 −3 protobufs/livekit_room.proto
+3 −0 protobufs/livekit_sip.proto
+3 −0 protobufs/rpc/sip.proto
+5 −4 rpc/sip.go
+25 −14 rpc/sip.pb.go
+62 −62 rpc/sip.psrpc.go
+567 −23 sdp/sdp.go
+180 −0 sdp/sdp_test.go
+10 −0 utils/hwstats/cpu.go
+1 −0 utils/hwstats/cpu_null.go
+41 −0 utils/hwstats/memory.go
+33 −0 utils/hwstats/memory_all.go
+160 −0 utils/hwstats/memory_linux.go
+21 −0 utils/hwstats/memory_nonlinux.go
+35 −6 utils/promise.go
+42 −0 utils/promise_test.go
+2 −17 webhook/resource_queue.go
48 changes: 36 additions & 12 deletions src/main/kotlin/io/livekit/server/EgressServiceClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2024 LiveKit, Inc.
* Copyright 2024-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.
Expand Down Expand Up @@ -33,6 +33,12 @@ data class EncodedOutputs(
val imageOutput: LivekitEgress.ImageOutput?,
)

enum class AudioMixing {
DEFAULT_MIXING,
DUAL_CHANNEL_AGENT,
DUAL_CHANNEL_ALTERNATE
}

/**
* A client for interacting with the Egress service.
*
Expand All @@ -53,7 +59,8 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions? = null,
audioOnly: Boolean = false,
videoOnly: Boolean = false,
customBaseUrl: String = ""
customBaseUrl: String = "",
audioMixing: AudioMixing = AudioMixing.DEFAULT_MIXING
): Call<LivekitEgress.EgressInfo> {
@Suppress("DEPRECATION")
val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
Expand All @@ -67,7 +74,8 @@ class EgressServiceClient(
optionsAdvanced,
audioOnly,
videoOnly,
customBaseUrl
customBaseUrl,
audioMixing
)
}

Expand All @@ -80,7 +88,8 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions? = null,
audioOnly: Boolean = false,
videoOnly: Boolean = false,
customBaseUrl: String = ""
customBaseUrl: String = "",
audioMixing: AudioMixing = AudioMixing.DEFAULT_MIXING
): Call<LivekitEgress.EgressInfo> {
@Suppress("DEPRECATION")
val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
Expand All @@ -94,7 +103,8 @@ class EgressServiceClient(
optionsAdvanced,
audioOnly,
videoOnly,
customBaseUrl
customBaseUrl,
audioMixing
)
}

Expand All @@ -107,7 +117,8 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions? = null,
audioOnly: Boolean = false,
videoOnly: Boolean = false,
customBaseUrl: String = ""
customBaseUrl: String = "",
audioMixing: AudioMixing = AudioMixing.DEFAULT_MIXING
): Call<LivekitEgress.EgressInfo> {
@Suppress("DEPRECATION")
val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
Expand All @@ -121,7 +132,8 @@ class EgressServiceClient(
optionsAdvanced,
audioOnly,
videoOnly,
customBaseUrl
customBaseUrl,
audioMixing
)
}

Expand All @@ -134,7 +146,8 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions? = null,
audioOnly: Boolean = false,
videoOnly: Boolean = false,
customBaseUrl: String = ""
customBaseUrl: String = "",
audioMixing: AudioMixing = AudioMixing.DEFAULT_MIXING,
): Call<LivekitEgress.EgressInfo> {
@Suppress("DEPRECATION")
val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
Expand All @@ -147,7 +160,8 @@ class EgressServiceClient(
optionsAdvanced,
audioOnly,
videoOnly,
customBaseUrl
customBaseUrl,
audioMixing
)
}

Expand All @@ -160,7 +174,8 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions? = null,
audioOnly: Boolean = false,
videoOnly: Boolean = false,
customBaseUrl: String = ""
customBaseUrl: String = "",
audioMixing: AudioMixing = AudioMixing.DEFAULT_MIXING,
): Call<LivekitEgress.EgressInfo> {
val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
if (output.fileOutput != null) {
Expand All @@ -184,7 +199,8 @@ class EgressServiceClient(
optionsAdvanced,
audioOnly,
videoOnly,
customBaseUrl
customBaseUrl,
audioMixing
)
}

Expand All @@ -196,8 +212,15 @@ class EgressServiceClient(
optionsAdvanced: LivekitEgress.EncodingOptions?,
audioOnly: Boolean,
videoOnly: Boolean,
customBaseUrl: String
customBaseUrl: String,
audioMixing: AudioMixing
): Call<LivekitEgress.EgressInfo> {
val protoAudioMixing = when (audioMixing) {
AudioMixing.DEFAULT_MIXING -> LivekitEgress.AudioMixing.DEFAULT_MIXING
AudioMixing.DUAL_CHANNEL_AGENT -> LivekitEgress.AudioMixing.DUAL_CHANNEL_AGENT
AudioMixing.DUAL_CHANNEL_ALTERNATE -> LivekitEgress.AudioMixing.DUAL_CHANNEL_ALTERNATE
}

val request = with(requestBuilder) {
this.roomName = roomName
this.layout = layout
Expand All @@ -209,6 +232,7 @@ class EgressServiceClient(
this.audioOnly = audioOnly
this.videoOnly = videoOnly
this.customBaseUrl = customBaseUrl
this.audioMixing = protoAudioMixing
build()
}
val credentials = authHeader(RoomRecord(true))
Expand Down
9 changes: 9 additions & 0 deletions src/main/kotlin/io/livekit/server/RoomServiceClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,14 @@ class RoomServiceClient(
return service.removeParticipant(request, credentials)
}

/**
* Forward a participant's track(s) to another room. Requires `roomAdmin` and `destinationRoom`. The forwarding will
* stop when the participant leaves the room or `RemoveParticipant` has been called in the destination room.
* A participant can be forwarded to multiple rooms. The destination room will be created if it does not exist.
* @param roomName
* @param identity
* @param destinationRoomName
*/
fun forwardParticipant(roomName: String, identity: String, destinationRoomName: String): Call<LivekitRoom.ForwardParticipantResponse> {
val request = LivekitRoom.ForwardParticipantRequest.newBuilder()
.setRoom(roomName)
Expand All @@ -198,6 +206,7 @@ class RoomServiceClient(
val credentials = authHeader(
RoomAdmin(true),
RoomName(roomName),
DestinationRoomName(destinationRoomName),
)
return service.forwardParticipant(request, credentials)
}
Expand Down
22 changes: 21 additions & 1 deletion src/main/kotlin/io/livekit/server/SipService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2024 LiveKit, Inc.
* Copyright 2024-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.
Expand Down Expand Up @@ -42,6 +42,20 @@ interface SipService {
@Header("Authorization") authorization: String
): Call<LivekitSip.SIPOutboundTrunkInfo>

@Headers("Content-Type: application/protobuf")
@POST("/twirp/livekit.SIP/UpdateSIPInboundTrunk")
fun updateSipInboundTrunk(
@Body request: LivekitSip.UpdateSIPInboundTrunkRequest,
@Header("Authorization") authorization: String
): Call<LivekitSip.SIPInboundTrunkInfo>

@Headers("Content-Type: application/protobuf")
@POST("/twirp/livekit.SIP/UpdateSIPOutboundTrunk")
fun updateSipOutboundTrunk(
@Body request: LivekitSip.UpdateSIPOutboundTrunkRequest,
@Header("Authorization") authorization: String
): Call<LivekitSip.SIPOutboundTrunkInfo>

@Headers("Content-Type: application/protobuf")
@POST("/twirp/livekit.SIP/ListSIPInboundTrunk")
fun listSIPInboundTrunk(
Expand Down Expand Up @@ -70,6 +84,12 @@ interface SipService {
@Header("Authorization") authorization: String
): Call<LivekitSip.SIPDispatchRuleInfo>

@POST("/twirp/livekit.SIP/UpdateSIPDispatchRule")
fun updateSipDispatchRule(
@Body request: LivekitSip.UpdateSIPDispatchRuleRequest,
@Header("Authorization") authorization: String
): Call<LivekitSip.SIPDispatchRuleInfo>

@Headers("Content-Type: application/protobuf")
@POST("/twirp/livekit.SIP/ListSIPDispatchRule")
fun listSipDispatchRule(
Expand Down
Loading