@livekit/protocol 1.39.3 → 1.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livekit/protocol",
3
- "version": "1.39.3",
3
+ "version": "1.40.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "require": "dist/index.cjs",
@@ -28,7 +28,7 @@
28
28
  "devDependencies": {
29
29
  "@bufbuild/protoc-gen-es": "^1.10.0",
30
30
  "genversion": "^3.2.0",
31
- "typescript": "5.8.3",
31
+ "typescript": "5.9.2",
32
32
  "unbuild": "^2.0.0"
33
33
  },
34
34
  "dependencies": {
@@ -185,6 +185,11 @@ export declare class JobState extends Message<JobState> {
185
185
  */
186
186
  workerId: string;
187
187
 
188
+ /**
189
+ * @generated from field: string agent_id = 8;
190
+ */
191
+ agentId: string;
192
+
188
193
  constructor(data?: PartialMessage<JobState>);
189
194
 
190
195
  static readonly runtime: typeof proto3;
@@ -87,6 +87,7 @@ export const JobState = /*@__PURE__*/ proto3.makeMessageType(
87
87
  { no: 5, name: "updated_at", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
88
88
  { no: 6, name: "participant_identity", kind: "scalar", T: 9 /* ScalarType.STRING */ },
89
89
  { no: 7, name: "worker_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
90
+ { no: 8, name: "agent_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
90
91
  ],
91
92
  );
92
93
 
@@ -64,6 +64,11 @@ export declare enum AnalyticsEventType {
64
64
  */
65
65
  PARTICIPANT_LEFT = 3,
66
66
 
67
+ /**
68
+ * @generated from enum value: PARTICIPANT_CONNECTION_ABORTED = 45;
69
+ */
70
+ PARTICIPANT_CONNECTION_ABORTED = 45,
71
+
67
72
  /**
68
73
  * @generated from enum value: TRACK_PUBLISHED = 4;
69
74
  */
@@ -45,6 +45,7 @@ export const AnalyticsEventType = /*@__PURE__*/ proto3.makeEnum(
45
45
  {no: 1, name: "ROOM_ENDED"},
46
46
  {no: 2, name: "PARTICIPANT_JOINED"},
47
47
  {no: 3, name: "PARTICIPANT_LEFT"},
48
+ {no: 45, name: "PARTICIPANT_CONNECTION_ABORTED"},
48
49
  {no: 4, name: "TRACK_PUBLISHED"},
49
50
  {no: 20, name: "TRACK_PUBLISH_REQUESTED"},
50
51
  {no: 5, name: "TRACK_UNPUBLISHED"},
@@ -356,6 +356,16 @@ export declare class AgentVersion extends Message<AgentVersion> {
356
356
  */
357
357
  createdAt?: Timestamp;
358
358
 
359
+ /**
360
+ * @generated from field: google.protobuf.Timestamp deployed_at = 4;
361
+ */
362
+ deployedAt?: Timestamp;
363
+
364
+ /**
365
+ * @generated from field: map<string, string> attributes = 5;
366
+ */
367
+ attributes: { [key: string]: string };
368
+
359
369
  constructor(data?: PartialMessage<AgentVersion>);
360
370
 
361
371
  static readonly runtime: typeof proto3;
@@ -511,6 +521,59 @@ export declare class UpdateAgentResponse extends Message<UpdateAgentResponse> {
511
521
  static equals(a: UpdateAgentResponse | PlainMessage<UpdateAgentResponse> | undefined, b: UpdateAgentResponse | PlainMessage<UpdateAgentResponse> | undefined): boolean;
512
522
  }
513
523
 
524
+ /**
525
+ * @generated from message livekit.RestartAgentRequest
526
+ */
527
+ export declare class RestartAgentRequest extends Message<RestartAgentRequest> {
528
+ /**
529
+ * @generated from field: string agent_id = 1;
530
+ */
531
+ agentId: string;
532
+
533
+ constructor(data?: PartialMessage<RestartAgentRequest>);
534
+
535
+ static readonly runtime: typeof proto3;
536
+ static readonly typeName = "livekit.RestartAgentRequest";
537
+ static readonly fields: FieldList;
538
+
539
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RestartAgentRequest;
540
+
541
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RestartAgentRequest;
542
+
543
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RestartAgentRequest;
544
+
545
+ static equals(a: RestartAgentRequest | PlainMessage<RestartAgentRequest> | undefined, b: RestartAgentRequest | PlainMessage<RestartAgentRequest> | undefined): boolean;
546
+ }
547
+
548
+ /**
549
+ * @generated from message livekit.RestartAgentResponse
550
+ */
551
+ export declare class RestartAgentResponse extends Message<RestartAgentResponse> {
552
+ /**
553
+ * @generated from field: bool success = 1;
554
+ */
555
+ success: boolean;
556
+
557
+ /**
558
+ * @generated from field: string message = 2;
559
+ */
560
+ message: string;
561
+
562
+ constructor(data?: PartialMessage<RestartAgentResponse>);
563
+
564
+ static readonly runtime: typeof proto3;
565
+ static readonly typeName = "livekit.RestartAgentResponse";
566
+ static readonly fields: FieldList;
567
+
568
+ static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RestartAgentResponse;
569
+
570
+ static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RestartAgentResponse;
571
+
572
+ static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RestartAgentResponse;
573
+
574
+ static equals(a: RestartAgentResponse | PlainMessage<RestartAgentResponse> | undefined, b: RestartAgentResponse | PlainMessage<RestartAgentResponse> | undefined): boolean;
575
+ }
576
+
514
577
  /**
515
578
  * @generated from message livekit.DeployAgentRequest
516
579
  */
@@ -127,6 +127,8 @@ export const AgentVersion = /*@__PURE__*/ proto3.makeMessageType(
127
127
  { no: 1, name: "version", kind: "scalar", T: 9 /* ScalarType.STRING */ },
128
128
  { no: 2, name: "current", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
129
129
  { no: 3, name: "created_at", kind: "message", T: Timestamp },
130
+ { no: 4, name: "deployed_at", kind: "message", T: Timestamp },
131
+ { no: 5, name: "attributes", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} },
130
132
  ],
131
133
  );
132
134
 
@@ -178,6 +180,27 @@ export const UpdateAgentResponse = /*@__PURE__*/ proto3.makeMessageType(
178
180
  ],
179
181
  );
180
182
 
183
+ /**
184
+ * @generated from message livekit.RestartAgentRequest
185
+ */
186
+ export const RestartAgentRequest = /*@__PURE__*/ proto3.makeMessageType(
187
+ "livekit.RestartAgentRequest",
188
+ () => [
189
+ { no: 1, name: "agent_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
190
+ ],
191
+ );
192
+
193
+ /**
194
+ * @generated from message livekit.RestartAgentResponse
195
+ */
196
+ export const RestartAgentResponse = /*@__PURE__*/ proto3.makeMessageType(
197
+ "livekit.RestartAgentResponse",
198
+ () => [
199
+ { no: 1, name: "success", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
200
+ { no: 2, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ },
201
+ ],
202
+ );
203
+
181
204
  /**
182
205
  * @generated from message livekit.DeployAgentRequest
183
206
  */
@@ -1130,6 +1130,20 @@ export declare class S3Upload extends Message<S3Upload> {
1130
1130
  */
1131
1131
  sessionToken: string;
1132
1132
 
1133
+ /**
1134
+ * ARN of the role to assume for file upload. Egress will make an AssumeRole API call using the provided access_key and secret to assume that role. On LiveKit cloud, this is only available on accounts that have the feature enabled
1135
+ *
1136
+ * @generated from field: string assume_role_arn = 12;
1137
+ */
1138
+ assumeRoleArn: string;
1139
+
1140
+ /**
1141
+ * ExternalID to use when assuming role for upload
1142
+ *
1143
+ * @generated from field: string assume_role_external_id = 13;
1144
+ */
1145
+ assumeRoleExternalId: string;
1146
+
1133
1147
  /**
1134
1148
  * @generated from field: string region = 3;
1135
1149
  */
@@ -329,6 +329,8 @@ export const S3Upload = /*@__PURE__*/ proto3.makeMessageType(
329
329
  { no: 1, name: "access_key", kind: "scalar", T: 9 /* ScalarType.STRING */ },
330
330
  { no: 2, name: "secret", kind: "scalar", T: 9 /* ScalarType.STRING */ },
331
331
  { no: 11, name: "session_token", kind: "scalar", T: 9 /* ScalarType.STRING */ },
332
+ { no: 12, name: "assume_role_arn", kind: "scalar", T: 9 /* ScalarType.STRING */ },
333
+ { no: 13, name: "assume_role_external_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
332
334
  { no: 3, name: "region", kind: "scalar", T: 9 /* ScalarType.STRING */ },
333
335
  { no: 4, name: "endpoint", kind: "scalar", T: 9 /* ScalarType.STRING */ },
334
336
  { no: 5, name: "bucket", kind: "scalar", T: 9 /* ScalarType.STRING */ },
@@ -21,6 +21,7 @@ import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialM
21
21
  import { Message, proto3 } from "@bufbuild/protobuf";
22
22
  import type { ClientInfo, PlayoutDelay, ReconnectReason } from "./livekit_models_pb.js";
23
23
  import type { CreateRoomRequest } from "./livekit_room_pb.js";
24
+ import type { AddTrackRequest, SessionDescription, SyncState } from "./livekit_rtc_pb.js";
24
25
  import type { AutoParticipantEgress, AutoTrackEgress } from "./livekit_egress_pb.js";
25
26
  import type { RoomAgentDispatch } from "./livekit_agent_dispatch_pb.js";
26
27
 
@@ -631,7 +632,8 @@ export declare class StartSession extends Message<StartSession> {
631
632
  autoSubscribe: boolean;
632
633
 
633
634
  /**
634
- * @generated from field: bool hidden = 10;
635
+ * @generated from field: bool hidden = 10 [deprecated = true];
636
+ * @deprecated
635
637
  */
636
638
  hidden: boolean;
637
639
 
@@ -641,7 +643,8 @@ export declare class StartSession extends Message<StartSession> {
641
643
  client?: ClientInfo;
642
644
 
643
645
  /**
644
- * @generated from field: bool recorder = 12;
646
+ * @generated from field: bool recorder = 12 [deprecated = true];
647
+ * @deprecated
645
648
  */
646
649
  recorder: boolean;
647
650
 
@@ -689,6 +692,21 @@ export declare class StartSession extends Message<StartSession> {
689
692
  */
690
693
  createRoom?: CreateRoomRequest;
691
694
 
695
+ /**
696
+ * @generated from field: repeated livekit.AddTrackRequest add_track_requests = 21;
697
+ */
698
+ addTrackRequests: AddTrackRequest[];
699
+
700
+ /**
701
+ * @generated from field: livekit.SessionDescription publisher_offer = 22;
702
+ */
703
+ publisherOffer?: SessionDescription;
704
+
705
+ /**
706
+ * @generated from field: livekit.SyncState sync_state = 23;
707
+ */
708
+ syncState?: SyncState;
709
+
692
710
  constructor(data?: PartialMessage<StartSession>);
693
711
 
694
712
  static readonly runtime: typeof proto3;
@@ -20,6 +20,7 @@
20
20
  import { proto3 } from "@bufbuild/protobuf";
21
21
  import { ClientInfo, PlayoutDelay, ReconnectReason } from "./livekit_models_pb.js";
22
22
  import { CreateRoomRequest } from "./livekit_room_pb.js";
23
+ import { AddTrackRequest, SessionDescription, SyncState } from "./livekit_rtc_pb.js";
23
24
  import { AutoParticipantEgress, AutoTrackEgress } from "./livekit_egress_pb.js";
24
25
  import { RoomAgentDispatch } from "./livekit_agent_dispatch_pb.js";
25
26
 
@@ -194,6 +195,9 @@ export const StartSession = /*@__PURE__*/ proto3.makeMessageType(
194
195
  { no: 18, name: "subscriber_allow_pause", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
195
196
  { no: 19, name: "disable_ice_lite", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
196
197
  { no: 20, name: "create_room", kind: "message", T: CreateRoomRequest },
198
+ { no: 21, name: "add_track_requests", kind: "message", T: AddTrackRequest, repeated: true },
199
+ { no: 22, name: "publisher_offer", kind: "message", T: SessionDescription },
200
+ { no: 23, name: "sync_state", kind: "message", T: SyncState },
197
201
  ],
198
202
  );
199
203
 
@@ -486,6 +486,27 @@ export declare class ListUpdate extends Message<ListUpdate> {
486
486
  */
487
487
  set: string[];
488
488
 
489
+ /**
490
+ * append items to a list, avoiding duplicates
491
+ *
492
+ * @generated from field: repeated string add = 2;
493
+ */
494
+ add: string[];
495
+
496
+ /**
497
+ * delete items from a list
498
+ *
499
+ * @generated from field: repeated string del = 3;
500
+ */
501
+ del: string[];
502
+
503
+ /**
504
+ * sets the list to an empty list
505
+ *
506
+ * @generated from field: bool clear = 4;
507
+ */
508
+ clear: boolean;
509
+
489
510
  constructor(data?: PartialMessage<ListUpdate>);
490
511
 
491
512
  static readonly runtime: typeof proto3;
@@ -996,6 +1017,21 @@ export declare class SimulcastCodecInfo extends Message<SimulcastCodecInfo> {
996
1017
  */
997
1018
  layers: VideoLayer[];
998
1019
 
1020
+ /**
1021
+ * @generated from field: livekit.VideoLayer.Mode video_layer_mode = 5;
1022
+ */
1023
+ videoLayerMode: VideoLayer_Mode;
1024
+
1025
+ /**
1026
+ * cid (client side id for track) could be different between
1027
+ * signalling (AddTrackRequest) and SDP offer. This field
1028
+ * will be populated only if it is different to avoid
1029
+ * duplication and keep the representation concise.
1030
+ *
1031
+ * @generated from field: string sdp_cid = 6;
1032
+ */
1033
+ sdpCid: string;
1034
+
999
1035
  constructor(data?: PartialMessage<SimulcastCodecInfo>);
1000
1036
 
1001
1037
  static readonly runtime: typeof proto3;
@@ -1039,28 +1075,36 @@ export declare class TrackInfo extends Message<TrackInfo> {
1039
1075
  * original width of video (unset for audio)
1040
1076
  * clients may receive a lower resolution version with simulcast
1041
1077
  *
1042
- * @generated from field: uint32 width = 5;
1078
+ * @generated from field: uint32 width = 5 [deprecated = true];
1079
+ * @deprecated
1043
1080
  */
1044
1081
  width: number;
1045
1082
 
1046
1083
  /**
1047
1084
  * original height of video (unset for audio)
1048
1085
  *
1049
- * @generated from field: uint32 height = 6;
1086
+ * @generated from field: uint32 height = 6 [deprecated = true];
1087
+ * @deprecated
1050
1088
  */
1051
1089
  height: number;
1052
1090
 
1053
1091
  /**
1054
1092
  * true if track is simulcasted
1055
1093
  *
1056
- * @generated from field: bool simulcast = 7;
1094
+ * see `video_layer_mode` in `codecs`
1095
+ *
1096
+ * @generated from field: bool simulcast = 7 [deprecated = true];
1097
+ * @deprecated
1057
1098
  */
1058
1099
  simulcast: boolean;
1059
1100
 
1060
1101
  /**
1061
1102
  * true if DTX (Discontinuous Transmission) is disabled for audio
1062
1103
  *
1063
- * @generated from field: bool disable_dtx = 8;
1104
+ * deprecated in favor of `audio_features`
1105
+ *
1106
+ * @generated from field: bool disable_dtx = 8 [deprecated = true];
1107
+ * @deprecated
1064
1108
  */
1065
1109
  disableDtx: boolean;
1066
1110
 
@@ -1072,7 +1116,10 @@ export declare class TrackInfo extends Message<TrackInfo> {
1072
1116
  source: TrackSource;
1073
1117
 
1074
1118
  /**
1075
- * @generated from field: repeated livekit.VideoLayer layers = 10;
1119
+ * see `codecs` for layers of individual codec
1120
+ *
1121
+ * @generated from field: repeated livekit.VideoLayer layers = 10 [deprecated = true];
1122
+ * @deprecated
1076
1123
  */
1077
1124
  layers: VideoLayer[];
1078
1125
 
@@ -1094,7 +1141,10 @@ export declare class TrackInfo extends Message<TrackInfo> {
1094
1141
  codecs: SimulcastCodecInfo[];
1095
1142
 
1096
1143
  /**
1097
- * @generated from field: bool stereo = 14;
1144
+ * deprecated in favor of `audio_features`
1145
+ *
1146
+ * @generated from field: bool stereo = 14 [deprecated = true];
1147
+ * @deprecated
1098
1148
  */
1099
1149
  stereo: boolean;
1100
1150
 
@@ -1205,6 +1255,26 @@ export declare class VideoLayer extends Message<VideoLayer> {
1205
1255
  static equals(a: VideoLayer | PlainMessage<VideoLayer> | undefined, b: VideoLayer | PlainMessage<VideoLayer> | undefined): boolean;
1206
1256
  }
1207
1257
 
1258
+ /**
1259
+ * @generated from enum livekit.VideoLayer.Mode
1260
+ */
1261
+ export declare enum VideoLayer_Mode {
1262
+ /**
1263
+ * @generated from enum value: MODE_UNUSED = 0;
1264
+ */
1265
+ MODE_UNUSED = 0,
1266
+
1267
+ /**
1268
+ * @generated from enum value: ONE_SPATIAL_LAYER_PER_STREAM = 1;
1269
+ */
1270
+ ONE_SPATIAL_LAYER_PER_STREAM = 1,
1271
+
1272
+ /**
1273
+ * @generated from enum value: MULTIPLE_SPATIAL_LAYERS_PER_STREAM = 2;
1274
+ */
1275
+ MULTIPLE_SPATIAL_LAYERS_PER_STREAM = 2,
1276
+ }
1277
+
1208
1278
  /**
1209
1279
  * new DataPacket API
1210
1280
  *
@@ -1355,6 +1425,7 @@ export declare enum DataPacket_Kind {
1355
1425
 
1356
1426
  /**
1357
1427
  * @generated from message livekit.ActiveSpeakerUpdate
1428
+ * @deprecated
1358
1429
  */
1359
1430
  export declare class ActiveSpeakerUpdate extends Message<ActiveSpeakerUpdate> {
1360
1431
  /**
@@ -222,6 +222,9 @@ export const ListUpdate = /*@__PURE__*/ proto3.makeMessageType(
222
222
  "livekit.ListUpdate",
223
223
  () => [
224
224
  { no: 1, name: "set", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
225
+ { no: 2, name: "add", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
226
+ { no: 3, name: "del", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
227
+ { no: 4, name: "clear", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
225
228
  ],
226
229
  );
227
230
 
@@ -382,6 +385,8 @@ export const SimulcastCodecInfo = /*@__PURE__*/ proto3.makeMessageType(
382
385
  { no: 2, name: "mid", kind: "scalar", T: 9 /* ScalarType.STRING */ },
383
386
  { no: 3, name: "cid", kind: "scalar", T: 9 /* ScalarType.STRING */ },
384
387
  { no: 4, name: "layers", kind: "message", T: VideoLayer, repeated: true },
388
+ { no: 5, name: "video_layer_mode", kind: "enum", T: proto3.getEnumType(VideoLayer_Mode) },
389
+ { no: 6, name: "sdp_cid", kind: "scalar", T: 9 /* ScalarType.STRING */ },
385
390
  ],
386
391
  );
387
392
 
@@ -432,6 +437,18 @@ export const VideoLayer = /*@__PURE__*/ proto3.makeMessageType(
432
437
  ],
433
438
  );
434
439
 
440
+ /**
441
+ * @generated from enum livekit.VideoLayer.Mode
442
+ */
443
+ export const VideoLayer_Mode = /*@__PURE__*/ proto3.makeEnum(
444
+ "livekit.VideoLayer.Mode",
445
+ [
446
+ {no: 0, name: "MODE_UNUSED"},
447
+ {no: 1, name: "ONE_SPATIAL_LAYER_PER_STREAM"},
448
+ {no: 2, name: "MULTIPLE_SPATIAL_LAYERS_PER_STREAM"},
449
+ ],
450
+ );
451
+
435
452
  /**
436
453
  * new DataPacket API
437
454
  *
@@ -473,6 +490,7 @@ export const DataPacket_Kind = /*@__PURE__*/ proto3.makeEnum(
473
490
 
474
491
  /**
475
492
  * @generated from message livekit.ActiveSpeakerUpdate
493
+ * @deprecated
476
494
  */
477
495
  export const ActiveSpeakerUpdate = /*@__PURE__*/ proto3.makeMessageType(
478
496
  "livekit.ActiveSpeakerUpdate",
@@ -730,6 +730,13 @@ export declare class RoomConfiguration extends Message<RoomConfiguration> {
730
730
  */
731
731
  maxParticipants: number;
732
732
 
733
+ /**
734
+ * metadata of room
735
+ *
736
+ * @generated from field: string metadata = 11;
737
+ */
738
+ metadata: string;
739
+
733
740
  /**
734
741
  * egress
735
742
  *
@@ -250,6 +250,7 @@ export const RoomConfiguration = /*@__PURE__*/ proto3.makeMessageType(
250
250
  { no: 2, name: "empty_timeout", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
251
251
  { no: 3, name: "departure_timeout", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
252
252
  { no: 4, name: "max_participants", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
253
+ { no: 11, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
253
254
  { no: 5, name: "egress", kind: "message", T: RoomEgress },
254
255
  { no: 7, name: "min_playout_delay", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
255
256
  { no: 8, name: "max_playout_delay", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },