Add support for Egress Image Output (#53)

livekit · Feb 27, 2024 · 59c553b · 59c553b
1 parent 45533a3
commit 59c553b
Show file tree

Hide file tree

Showing 2 changed files with 116 additions and 0 deletions.
diff --git a/src/main/kotlin/io/livekit/server/EgressServiceClient.kt b/src/main/kotlin/io/livekit/server/EgressServiceClient.kt
@@ -28,6 +28,7 @@ data class EncodedOutputs(
     val fileOutput: LivekitEgress.EncodedFileOutput?,
     val streamOutput: LivekitEgress.StreamOutput?,
     val segmentOutput: LivekitEgress.SegmentedFileOutput?,
+    val imageOutput: LivekitEgress.ImageOutput?,
 )
 
 class EgressServiceClient(
@@ -117,6 +118,32 @@ class EgressServiceClient(
         )
     }
 
+    @JvmOverloads
+    fun startRoomCompositeEgress(
+        roomName: String,
+        output: LivekitEgress.ImageOutput,
+        layout: String = "",
+        optionsPreset: LivekitEgress.EncodingOptionsPreset? = null,
+        optionsAdvanced: LivekitEgress.EncodingOptions? = null,
+        audioOnly: Boolean = false,
+        videoOnly: Boolean = false,
+        customBaseUrl: String = ""
+    ): Call<LivekitEgress.EgressInfo> {
+        @Suppress("DEPRECATION")
+        val requestBuilder = LivekitEgress.RoomCompositeEgressRequest.newBuilder()
+            .addImageOutputs(output)
+        return startRoomCompositeEgressImpl(
+            requestBuilder,
+            roomName,
+            layout,
+            optionsPreset,
+            optionsAdvanced,
+            audioOnly,
+            videoOnly,
+            customBaseUrl
+        )
+    }
+
     @JvmOverloads
     fun startRoomCompositeEgress(
         roomName: String,
@@ -138,6 +165,10 @@ class EgressServiceClient(
         if (output.segmentOutput != null) {
             requestBuilder.addSegmentOutputs(output.segmentOutput)
         }
+        if (output.imageOutput != null) {
+            requestBuilder.addImageOutputs(output.imageOutput)
+        }
+
         return startRoomCompositeEgressImpl(
             requestBuilder,
             roomName,
@@ -197,6 +228,10 @@ class EgressServiceClient(
         if (output.segmentOutput != null) {
             requestBuilder.addSegmentOutputs(output.segmentOutput)
         }
+        if (output.imageOutput != null) {
+            requestBuilder.addImageOutputs(output.imageOutput)
+        }
+
         return startParticipantEgressImpl(
             requestBuilder,
             roomName,
@@ -300,6 +335,28 @@ class EgressServiceClient(
         )
     }
 
+    @JvmOverloads
+    fun startTrackCompositeEgress(
+        roomName: String,
+        output: LivekitEgress.ImageOutput,
+        audioTrackId: String?,
+        videoTrackId: String?,
+        optionsPreset: LivekitEgress.EncodingOptionsPreset? = null,
+        optionsAdvanced: LivekitEgress.EncodingOptions? = null,
+    ): Call<LivekitEgress.EgressInfo> {
+        @Suppress("DEPRECATION")
+        val requestBuilder = LivekitEgress.TrackCompositeEgressRequest.newBuilder()
+            .addImageOutputs(output)
+        return startTrackCompositeEgressImpl(
+            requestBuilder,
+            roomName,
+            audioTrackId,
+            videoTrackId,
+            optionsPreset,
+            optionsAdvanced,
+        )
+    }
+
     @JvmOverloads
     fun startTrackCompositeEgress(
         roomName: String,
@@ -319,6 +376,10 @@ class EgressServiceClient(
         if (output.segmentOutput != null) {
             requestBuilder.addSegmentOutputs(output.segmentOutput)
         }
+        if (output.imageOutput != null) {
+            requestBuilder.addImageOutputs(output.imageOutput)
+        }
+
         return startTrackCompositeEgressImpl(
             requestBuilder,
             roomName,
@@ -459,6 +520,30 @@ class EgressServiceClient(
         )
     }
 
+    @JvmOverloads
+    fun startWebEgress(
+        url: String,
+        output: LivekitEgress.ImageOutput,
+        optionsPreset: LivekitEgress.EncodingOptionsPreset? = null,
+        optionsAdvanced: LivekitEgress.EncodingOptions? = null,
+        audioOnly: Boolean = false,
+        videoOnly: Boolean = false,
+        awaitStartSignal: Boolean = false
+    ): Call<LivekitEgress.EgressInfo> {
+        @Suppress("DEPRECATION")
+        val requestBuilder = LivekitEgress.WebEgressRequest.newBuilder()
+            .addImageOutputs(output)
+        return startWebEgressImpl(
+            requestBuilder,
+            url,
+            optionsPreset,
+            optionsAdvanced,
+            audioOnly,
+            videoOnly,
+            awaitStartSignal
+        )
+    }
+
     @JvmOverloads
     fun startWebEgress(
         url: String,
@@ -479,6 +564,10 @@ class EgressServiceClient(
         if (output.segmentOutput != null) {
             requestBuilder.addSegmentOutputs(output.segmentOutput)
         }
+        if (output.imageOutput != null) {
+            requestBuilder.addImageOutputs(output.imageOutput)
+        }
+
         return startWebEgressImpl(
             requestBuilder,
             url,

diff --git a/src/test/kotlin/io/livekit/server/EgressServiceClientTest.kt b/src/test/kotlin/io/livekit/server/EgressServiceClientTest.kt
@@ -33,6 +33,7 @@ class EgressServiceClientTest {
             fileOutput = LivekitEgress.EncodedFileOutput.getDefaultInstance(),
             streamOutput = LivekitEgress.StreamOutput.getDefaultInstance(),
             segmentOutput = LivekitEgress.SegmentedFileOutput.getDefaultInstance(),
+            imageOutput = LivekitEgress.ImageOutput.getDefaultInstance(),
         )
     }
 
@@ -77,6 +78,14 @@ class EgressServiceClientTest {
         )
     }
 
+    @Test
+    fun startRoomCompositeEgressImage() {
+        client.startRoomCompositeEgress(
+            roomName = "room",
+            output = LivekitEgress.ImageOutput.getDefaultInstance()
+        )
+    }
+
     @Test
     fun startRoomCompositeEgressEncodedOutputs() {
         client.startRoomCompositeEgress(
@@ -115,6 +124,16 @@ class EgressServiceClientTest {
         )
     }
 
+    @Test
+    fun startTrackCompositeEgressImage() {
+        client.startTrackCompositeEgress(
+            roomName = "room",
+            output = LivekitEgress.ImageOutput.getDefaultInstance(),
+            audioTrackId = "audio",
+            videoTrackId = "video",
+        )
+    }
+
     @Test
     fun startTrackCompositeEgressEncodedOutputs() {
         client.startTrackCompositeEgress(
@@ -149,6 +168,14 @@ class EgressServiceClientTest {
         )
     }
 
+    @Test
+    fun startWebEgressImage() {
+        client.startWebEgress(
+            url = "http://www.example.com",
+            output = LivekitEgress.ImageOutput.getDefaultInstance(),
+        )
+    }
+
     @Test
     fun startWebEgressEncodedOutputs() {
         client.startWebEgress(