Add support for Egress Image Output (livekit#143)

---------

Co-authored-by: lukasIO <[email protected]>

.changeset/seven-peaches-smell.md

@@ -0,0 +1,5 @@
+---
+"livekit-server-sdk": patch
+---
+
+Add support for Egress Image Output

src/EgressClient.ts

@@ -4,6 +4,7 @@ import {
   EncodedFileOutput,
   EncodingOptions,
   EncodingOptionsPreset,
+  ImageOutput,
   ListEgressRequest,
   ListEgressResponse,
   ParticipantEgressRequest,
@@ -98,6 +99,7 @@ export interface EncodedOutputs {
   file?: EncodedFileOutput | undefined;
   stream?: StreamOutput | undefined;
   segments?: SegmentedFileOutput | undefined;
+  images?: ImageOutput | undefined;
 }
 
 export interface ListEgressOptions {
@@ -178,6 +180,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     } = this.getOutputParams(output, options);
 
     const req = new RoomCompositeEgressRequest({
@@ -191,6 +194,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     }).toJson();
 
     const data = await this.rpc.request(
@@ -221,6 +225,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     } = this.getOutputParams(output, opts?.encodingOptions);
 
     const req = new WebEgressRequest({
@@ -233,6 +238,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     }).toJson();
 
     const data = await this.rpc.request(
@@ -257,17 +263,16 @@ export class EgressClient extends ServiceBase {
     output: EncodedOutputs,
     opts?: ParticipantEgressOptions,
   ): Promise<EgressInfo> {
-    const { options, fileOutputs, streamOutputs, segmentOutputs } = this.getOutputParams(
-      output,
-      opts?.encodingOptions,
-    );
+    const { options, fileOutputs, streamOutputs, segmentOutputs, imageOutputs } =
+      this.getOutputParams(output, opts?.encodingOptions);
     const req = new ParticipantEgressRequest({
       roomName,
       identity,
       options,
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     }).toJson();
 
     const data = await this.rpc.request(
@@ -327,6 +332,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     } = this.getOutputParams(output, options);
     const req = new TrackCompositeEgressRequest({
       roomName,
@@ -337,6 +343,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     }).toJson();
 
     const data = await this.rpc.request(
@@ -387,6 +394,7 @@ export class EgressClient extends ServiceBase {
     let streamOutputs: Array<StreamOutput> | undefined;
     let segments: SegmentedFileOutput | undefined;
     let segmentOutputs: Array<SegmentedFileOutput> | undefined;
+    let imageOutputs: Array<ImageOutput> | undefined;
 
     if (this.isEncodedOutputs(output)) {
       if (output.file !== undefined) {
@@ -398,6 +406,9 @@ export class EgressClient extends ServiceBase {
       if (output.segments !== undefined) {
         segmentOutputs = [output.segments];
       }
+      if (output.images !== undefined) {
+        imageOutputs = [output.images];
+      }
     } else if (this.isEncodedFileOutput(output)) {
       file = output;
       fileOutputs = [file];
@@ -470,6 +481,7 @@ export class EgressClient extends ServiceBase {
       fileOutputs,
       streamOutputs,
       segmentOutputs,
+      imageOutputs,
     };
   }
 

src/index.ts

@@ -14,6 +14,7 @@ export {
   EncodingOptions,
   EncodingOptionsPreset,
   GCPUpload,
+  ImageOutput,
   ParticipantEgressRequest,
   RoomCompositeEgressRequest,
   S3Upload,