@livekit/protocol 1.20.0 → 1.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/protocol",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "",
   "type": "module",
   "main": "src/index.js",

package/src/gen/livekit_internal_pb.d.ts

@@ -20,6 +20,7 @@
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
 import type { ClientInfo, PlayoutDelay, ReconnectReason } from "./livekit_models_pb.js";
+import type { CreateRoomRequest } from "./livekit_room_pb.js";
 import type { AutoParticipantEgress, AutoTrackEgress } from "./livekit_egress_pb.js";
 import type { RoomAgentDispatch } from "./livekit_agent_dispatch_pb.js";
 
@@ -519,6 +520,11 @@ export declare class StartSession extends Message<StartSession> {
    */
   disableIceLite: boolean;
 
+  /**
+   * @generated from field: livekit.CreateRoomRequest create_room = 20;
+   */
+  createRoom?: CreateRoomRequest;
+
   constructor(data?: PartialMessage<StartSession>);
 
   static readonly runtime: typeof proto3;

package/src/gen/livekit_internal_pb.js

@@ -19,6 +19,7 @@
 
 import { proto3 } from "@bufbuild/protobuf";
 import { ClientInfo, PlayoutDelay, ReconnectReason } from "./livekit_models_pb.js";
+import { CreateRoomRequest } from "./livekit_room_pb.js";
 import { AutoParticipantEgress, AutoTrackEgress } from "./livekit_egress_pb.js";
 import { RoomAgentDispatch } from "./livekit_agent_dispatch_pb.js";
 
@@ -156,6 +157,7 @@ export const StartSession = /*@__PURE__*/ proto3.makeMessageType(
     { no: 17, name: "reconnect_reason", kind: "enum", T: proto3.getEnumType(ReconnectReason) },
     { no: 18, name: "subscriber_allow_pause", kind: "scalar", T: 8 /* ScalarType.BOOL */, opt: true },
     { no: 19, name: "disable_ice_lite", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 20, name: "create_room", kind: "message", T: CreateRoomRequest },
   ],
 );
 

package/src/gen/livekit_metrics_pb.d.ts

@@ -0,0 +1,216 @@
+// @generated by protoc-gen-es v1.10.0 with parameter "target=js+dts"
+// @generated from file livekit_metrics.proto (package livekit, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3 } from "@bufbuild/protobuf";
+
+/**
+ * index from [0; 512] are for predefined labels (`MetricLabel`)
+ *
+ * @generated from enum livekit.MetricLabel
+ */
+export declare enum MetricLabel {
+  /**
+   * time to first token from LLM
+   *
+   * @generated from enum value: AGENTS_LLM_TTFT = 0;
+   */
+  AGENTS_LLM_TTFT = 0,
+
+  /**
+   * time to final transcription
+   *
+   * @generated from enum value: AGENTS_STT_TTFT = 1;
+   */
+  AGENTS_STT_TTFT = 1,
+
+  /**
+   * time to first byte
+   *
+   * @generated from enum value: AGENTS_TTS_TTFB = 2;
+   */
+  AGENTS_TTS_TTFB = 2,
+
+  /**
+   * @generated from enum value: METRIC_LABEL_MAX_VALUE = 512;
+   */
+  METRIC_LABEL_MAX_VALUE = 512,
+}
+
+/**
+ * @generated from message livekit.MetricsBatch
+ */
+export declare class MetricsBatch extends Message<MetricsBatch> {
+  /**
+   * To avoid repeating string values, we store them in a separate list and reference them by index
+   * This is useful for storing participant identities, track names, etc.
+   * There is also a predefined list of labels that can be used to reference common metrics.
+   * They have reserved indices from 0 to 512
+   *
+   * @generated from field: repeated string str_data = 1;
+   */
+  strData: string[];
+
+  /**
+   * @generated from field: repeated livekit.TimeSeriesMetric time_series = 2;
+   */
+  timeSeries: TimeSeriesMetric[];
+
+  /**
+   * @generated from field: repeated livekit.EventMetric events = 3;
+   */
+  events: EventMetric[];
+
+  constructor(data?: PartialMessage<MetricsBatch>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.MetricsBatch";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MetricsBatch;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MetricsBatch;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MetricsBatch;
+
+  static equals(a: MetricsBatch | PlainMessage<MetricsBatch> | undefined, b: MetricsBatch | PlainMessage<MetricsBatch> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.TimeSeriesMetric
+ */
+export declare class TimeSeriesMetric extends Message<TimeSeriesMetric> {
+  /**
+   * Metric name e.g "speech_probablity". The string value is not directly stored in the message, but referenced by index
+   * in the `str_data` field of `MetricsBatch`
+   *
+   * @generated from field: uint32 label = 1;
+   */
+  label: number;
+
+  /**
+   * @generated from field: uint32 participant_identity = 2;
+   */
+  participantIdentity: number;
+
+  /**
+   * @generated from field: uint32 track_sid = 3;
+   */
+  trackSid: number;
+
+  /**
+   * samples
+   *
+   * @generated from field: int64 start_timestamp = 4;
+   */
+  startTimestamp: bigint;
+
+  /**
+   * @generated from field: int64 end_timestamp = 5;
+   */
+  endTimestamp: bigint;
+
+  /**
+   * list of samples between start_timestamp and end_timestamp
+   *
+   * @generated from field: repeated livekit.MetricSample samples = 6;
+   */
+  samples: MetricSample[];
+
+  constructor(data?: PartialMessage<TimeSeriesMetric>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.TimeSeriesMetric";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TimeSeriesMetric;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TimeSeriesMetric;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TimeSeriesMetric;
+
+  static equals(a: TimeSeriesMetric | PlainMessage<TimeSeriesMetric> | undefined, b: TimeSeriesMetric | PlainMessage<TimeSeriesMetric> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.MetricSample
+ */
+export declare class MetricSample extends Message<MetricSample> {
+  /**
+   * @generated from field: int64 timestamp = 1;
+   */
+  timestamp: bigint;
+
+  /**
+   * @generated from field: float value = 2;
+   */
+  value: number;
+
+  constructor(data?: PartialMessage<MetricSample>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.MetricSample";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MetricSample;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MetricSample;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): MetricSample;
+
+  static equals(a: MetricSample | PlainMessage<MetricSample> | undefined, b: MetricSample | PlainMessage<MetricSample> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.EventMetric
+ */
+export declare class EventMetric extends Message<EventMetric> {
+  /**
+   * @generated from field: uint32 label = 1;
+   */
+  label: number;
+
+  /**
+   * @generated from field: uint32 participant_identity = 2;
+   */
+  participantIdentity: number;
+
+  /**
+   * 0 =
+   *
+   * @generated from field: uint32 track_sid = 3;
+   */
+  trackSid: number;
+
+  /**
+   * @generated from field: int64 start_timestamp = 4;
+   */
+  startTimestamp: bigint;
+
+  /**
+   * @generated from field: optional int64 end_timestamp = 5;
+   */
+  endTimestamp?: bigint;
+
+  /**
+   * @generated from field: string metadata = 6;
+   */
+  metadata: string;
+
+  constructor(data?: PartialMessage<EventMetric>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.EventMetric";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): EventMetric;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): EventMetric;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): EventMetric;
+
+  static equals(a: EventMetric | PlainMessage<EventMetric> | undefined, b: EventMetric | PlainMessage<EventMetric> | undefined): boolean;
+}
+

package/src/gen/livekit_metrics_pb.js

@@ -0,0 +1,75 @@
+// @generated by protoc-gen-es v1.10.0 with parameter "target=js+dts"
+// @generated from file livekit_metrics.proto (package livekit, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+
+/**
+ * index from [0; 512] are for predefined labels (`MetricLabel`)
+ *
+ * @generated from enum livekit.MetricLabel
+ */
+export const MetricLabel = /*@__PURE__*/ proto3.makeEnum(
+  "livekit.MetricLabel",
+  [
+    {no: 0, name: "AGENTS_LLM_TTFT"},
+    {no: 1, name: "AGENTS_STT_TTFT"},
+    {no: 2, name: "AGENTS_TTS_TTFB"},
+    {no: 512, name: "METRIC_LABEL_MAX_VALUE"},
+  ],
+);
+
+/**
+ * @generated from message livekit.MetricsBatch
+ */
+export const MetricsBatch = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.MetricsBatch",
+  () => [
+    { no: 1, name: "str_data", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
+    { no: 2, name: "time_series", kind: "message", T: TimeSeriesMetric, repeated: true },
+    { no: 3, name: "events", kind: "message", T: EventMetric, repeated: true },
+  ],
+);
+
+/**
+ * @generated from message livekit.TimeSeriesMetric
+ */
+export const TimeSeriesMetric = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.TimeSeriesMetric",
+  () => [
+    { no: 1, name: "label", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 2, name: "participant_identity", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 3, name: "track_sid", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 4, name: "start_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 5, name: "end_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 6, name: "samples", kind: "message", T: MetricSample, repeated: true },
+  ],
+);
+
+/**
+ * @generated from message livekit.MetricSample
+ */
+export const MetricSample = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.MetricSample",
+  () => [
+    { no: 1, name: "timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 2, name: "value", kind: "scalar", T: 2 /* ScalarType.FLOAT */ },
+  ],
+);
+
+/**
+ * @generated from message livekit.EventMetric
+ */
+export const EventMetric = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.EventMetric",
+  () => [
+    { no: 1, name: "label", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 2, name: "participant_identity", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 3, name: "track_sid", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 4, name: "start_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */ },
+    { no: 5, name: "end_timestamp", kind: "scalar", T: 3 /* ScalarType.INT64 */, opt: true },
+    { no: 6, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ],
+);
+

package/src/gen/livekit_models_pb.d.ts

@@ -19,6 +19,7 @@
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage, Timestamp } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
+import type { MetricsBatch } from "./livekit_metrics_pb.js";
 
 /**
  * @generated from enum livekit.AudioCodec
@@ -581,6 +582,13 @@ export declare class ParticipantPermission extends Message<ParticipantPermission
    */
   agent: boolean;
 
+  /**
+   * if a participant can subscribe to metrics
+   *
+   * @generated from field: bool can_subscribe_metrics = 12;
+   */
+  canSubscribeMetrics: boolean;
+
   constructor(data?: PartialMessage<ParticipantPermission>);
 
   static readonly runtime: typeof proto3;
@@ -1074,6 +1082,12 @@ export declare class DataPacket extends Message<DataPacket> {
      */
     value: Transcription;
     case: "transcription";
+  } | {
+    /**
+     * @generated from field: livekit.MetricsBatch metrics = 8;
+     */
+    value: MetricsBatch;
+    case: "metrics";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<DataPacket>);
@@ -1599,6 +1613,16 @@ export declare enum ClientInfo_SDK {
    * @generated from enum value: CPP = 10;
    */
   CPP = 10,
+
+  /**
+   * @generated from enum value: UNITY_WEB = 11;
+   */
+  UNITY_WEB = 11,
+
+  /**
+   * @generated from enum value: NODE = 12;
+   */
+  NODE = 12,
 }
 
 /**

package/src/gen/livekit_models_pb.js

@@ -18,6 +18,7 @@
 // @ts-nocheck
 
 import { proto3, Timestamp } from "@bufbuild/protobuf";
+import { MetricsBatch } from "./livekit_metrics_pb.js";
 
 /**
  * @generated from enum livekit.AudioCodec
@@ -240,6 +241,7 @@ export const ParticipantPermission = /*@__PURE__*/ proto3.makeMessageType(
     { no: 8, name: "recorder", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
     { no: 10, name: "can_update_metadata", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
     { no: 11, name: "agent", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 12, name: "can_subscribe_metrics", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
   ],
 );
 
@@ -385,6 +387,7 @@ export const DataPacket = /*@__PURE__*/ proto3.makeMessageType(
     { no: 3, name: "speaker", kind: "message", T: ActiveSpeakerUpdate, oneof: "value" },
     { no: 6, name: "sip_dtmf", kind: "message", T: SipDTMF, oneof: "value" },
     { no: 7, name: "transcription", kind: "message", T: Transcription, oneof: "value" },
+    { no: 8, name: "metrics", kind: "message", T: MetricsBatch, oneof: "value" },
   ],
 );
 
@@ -555,6 +558,8 @@ export const ClientInfo_SDK = /*@__PURE__*/ proto3.makeEnum(
     {no: 8, name: "RUST"},
     {no: 9, name: "PYTHON"},
     {no: 10, name: "CPP"},
+    {no: 11, name: "UNITY_WEB"},
+    {no: 12, name: "NODE"},
   ],
 );
 

package/src/gen/livekit_rtc_pb.d.ts

@@ -19,7 +19,7 @@
 
 import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
 import { Message, proto3 } from "@bufbuild/protobuf";
-import type { AudioTrackFeature, ClientConfiguration, ConnectionQuality, DisconnectReason, Encryption_Type, ParticipantInfo, ParticipantTracks, Room, ServerInfo, SpeakerInfo, SubscriptionError, TrackInfo, TrackSource, TrackType, VideoLayer, VideoQuality } from "./livekit_models_pb.js";
+import type { AudioTrackFeature, ClientConfiguration, Codec, ConnectionQuality, DisconnectReason, Encryption_Type, ParticipantInfo, ParticipantTracks, Room, ServerInfo, SpeakerInfo, SubscriptionError, TrackInfo, TrackSource, TrackType, VideoLayer, VideoQuality } from "./livekit_models_pb.js";
 
 /**
  * @generated from enum livekit.SignalTarget
@@ -713,6 +713,18 @@ export declare class JoinResponse extends Message<JoinResponse> {
    */
   sifTrailer: Uint8Array;
 
+  /**
+   * @generated from field: repeated livekit.Codec enabled_publish_codecs = 14;
+   */
+  enabledPublishCodecs: Codec[];
+
+  /**
+   * when set, client should attempt to establish publish peer connection when joining room to speed up publishing
+   *
+   * @generated from field: bool fast_publish = 15;
+   */
+  fastPublish: boolean;
+
   constructor(data?: PartialMessage<JoinResponse>);
 
   static readonly runtime: typeof proto3;

package/src/gen/livekit_rtc_pb.js

@@ -18,7 +18,7 @@
 // @ts-nocheck
 
 import { proto3 } from "@bufbuild/protobuf";
-import { AudioTrackFeature, ClientConfiguration, ConnectionQuality, DisconnectReason, Encryption_Type, ParticipantInfo, ParticipantTracks, Room, ServerInfo, SpeakerInfo, SubscriptionError, TrackInfo, TrackSource, TrackType, VideoLayer, VideoQuality } from "./livekit_models_pb.js";
+import { AudioTrackFeature, ClientConfiguration, Codec, ConnectionQuality, DisconnectReason, Encryption_Type, ParticipantInfo, ParticipantTracks, Room, ServerInfo, SpeakerInfo, SubscriptionError, TrackInfo, TrackSource, TrackType, VideoLayer, VideoQuality } from "./livekit_models_pb.js";
 
 /**
  * @generated from enum livekit.SignalTarget
@@ -188,6 +188,8 @@ export const JoinResponse = /*@__PURE__*/ proto3.makeMessageType(
     { no: 11, name: "ping_interval", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
     { no: 12, name: "server_info", kind: "message", T: ServerInfo },
     { no: 13, name: "sif_trailer", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
+    { no: 14, name: "enabled_publish_codecs", kind: "message", T: Codec, repeated: true },
+    { no: 15, name: "fast_publish", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
   ],
 );
 

package/src/gen/livekit_sip_pb.d.ts

@@ -691,6 +691,46 @@ export declare class SIPDispatchRuleIndividual extends Message<SIPDispatchRuleIn
   static equals(a: SIPDispatchRuleIndividual | PlainMessage<SIPDispatchRuleIndividual> | undefined, b: SIPDispatchRuleIndividual | PlainMessage<SIPDispatchRuleIndividual> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.SIPDispatchRuleCallee
+ */
+export declare class SIPDispatchRuleCallee extends Message<SIPDispatchRuleCallee> {
+  /**
+   * Prefix used on new room name
+   *
+   * @generated from field: string room_prefix = 1;
+   */
+  roomPrefix: string;
+
+  /**
+   * Optional pin required to enter room
+   *
+   * @generated from field: string pin = 2;
+   */
+  pin: string;
+
+  /**
+   * Optionally append random suffix
+   *
+   * @generated from field: bool randomize = 3;
+   */
+  randomize: boolean;
+
+  constructor(data?: PartialMessage<SIPDispatchRuleCallee>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.SIPDispatchRuleCallee";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SIPDispatchRuleCallee;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SIPDispatchRuleCallee;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SIPDispatchRuleCallee;
+
+  static equals(a: SIPDispatchRuleCallee | PlainMessage<SIPDispatchRuleCallee> | undefined, b: SIPDispatchRuleCallee | PlainMessage<SIPDispatchRuleCallee> | undefined): boolean;
+}
+
 /**
  * @generated from message livekit.SIPDispatchRule
  */
@@ -716,6 +756,14 @@ export declare class SIPDispatchRule extends Message<SIPDispatchRule> {
      */
     value: SIPDispatchRuleIndividual;
     case: "dispatchRuleIndividual";
+  } | {
+    /**
+     * SIPDispatchRuleCallee is a `SIP Dispatch Rule` that creates a new room for each callee.
+     *
+     * @generated from field: livekit.SIPDispatchRuleCallee dispatch_rule_callee = 3;
+     */
+    value: SIPDispatchRuleCallee;
+    case: "dispatchRuleCallee";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<SIPDispatchRule>);

package/src/gen/livekit_sip_pb.js

@@ -231,6 +231,18 @@ export const SIPDispatchRuleIndividual = /*@__PURE__*/ proto3.makeMessageType(
   ],
 );
 
+/**
+ * @generated from message livekit.SIPDispatchRuleCallee
+ */
+export const SIPDispatchRuleCallee = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.SIPDispatchRuleCallee",
+  () => [
+    { no: 1, name: "room_prefix", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "pin", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "randomize", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+  ],
+);
+
 /**
  * @generated from message livekit.SIPDispatchRule
  */
@@ -239,6 +251,7 @@ export const SIPDispatchRule = /*@__PURE__*/ proto3.makeMessageType(
   () => [
     { no: 1, name: "dispatch_rule_direct", kind: "message", T: SIPDispatchRuleDirect, oneof: "rule" },
     { no: 2, name: "dispatch_rule_individual", kind: "message", T: SIPDispatchRuleIndividual, oneof: "rule" },
+    { no: 3, name: "dispatch_rule_callee", kind: "message", T: SIPDispatchRuleCallee, oneof: "rule" },
   ],
 );
 

package/src/gen/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '1.20.0';
+export const version = '1.21.0';