@livekit/protocol 1.22.0 → 1.23.0

package/package.json

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

package/src/gen/livekit_metrics_pb.d.ts

@@ -33,6 +33,104 @@ export declare enum MetricLabel {
    */
   AGENTS_TTS_TTFB = 2,
 
+  /**
+   * Number of video freezes
+   *
+   * @generated from enum value: CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT = 3;
+   */
+  CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT = 3,
+
+  /**
+   * total duration of freezes
+   *
+   * @generated from enum value: CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION = 4;
+   */
+  CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION = 4,
+
+  /**
+   * number of video pauses
+   *
+   * @generated from enum value: CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT = 5;
+   */
+  CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT = 5,
+
+  /**
+   * total duration of pauses
+   *
+   * @generated from enum value: CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION = 6;
+   */
+  CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION = 6,
+
+  /**
+   * number of concealed (synthesized) audio samples
+   *
+   * @generated from enum value: CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES = 7;
+   */
+  CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES = 7,
+
+  /**
+   * number of silent concealed samples
+   *
+   * @generated from enum value: CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES = 8;
+   */
+  CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES = 8,
+
+  /**
+   * number of concealment events
+   *
+   * @generated from enum value: CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS = 9;
+   */
+  CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS = 9,
+
+  /**
+   * number of interruptions
+   *
+   * @generated from enum value: CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT = 10;
+   */
+  CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT = 10,
+
+  /**
+   * total duration of interruptions
+   *
+   * @generated from enum value: CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION = 11;
+   */
+  CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION = 11,
+
+  /**
+   * total time spent in jitter buffer
+   *
+   * @generated from enum value: CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY = 12;
+   */
+  CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY = 12,
+
+  /**
+   * total time spent in jitter buffer
+   *
+   * @generated from enum value: CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT = 13;
+   */
+  CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT = 13,
+
+  /**
+   * total duration spent in bandwidth quality limitation
+   *
+   * @generated from enum value: CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH = 14;
+   */
+  CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH = 14,
+
+  /**
+   * total duration spent in cpu quality limitation
+   *
+   * @generated from enum value: CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU = 15;
+   */
+  CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU = 15,
+
+  /**
+   * total duration spent in other quality limitation
+   *
+   * @generated from enum value: CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER = 16;
+   */
+  CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER = 16,
+
   /**
    * @generated from enum value: METRIC_LABEL_PREDEFINED_MAX_VALUE = 4096;
    */
@@ -59,7 +157,9 @@ 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 (METRIC_LABEL_PREDEFINED_MAX_VALUE - 1)
+   * They have reserved indices from 0 to (METRIC_LABEL_PREDEFINED_MAX_VALUE - 1).
+   * Indexes pointing at str_data should start from METRIC_LABEL_PREDEFINED_MAX_VALUE, 
+   * such that str_data[0] == index of METRIC_LABEL_PREDEFINED_MAX_VALUE.
    *
    * @generated from field: repeated string str_data = 3;
    */
@@ -121,6 +221,13 @@ export declare class TimeSeriesMetric extends Message<TimeSeriesMetric> {
    */
   samples: MetricSample[];
 
+  /**
+   * index into 'str_data'
+   *
+   * @generated from field: uint32 rid = 5;
+   */
+  rid: number;
+
   constructor(data?: PartialMessage<TimeSeriesMetric>);
 
   static readonly runtime: typeof proto3;
@@ -224,6 +331,13 @@ export declare class EventMetric extends Message<EventMetric> {
    */
   metadata: string;
 
+  /**
+   * index into 'str_data'
+   *
+   * @generated from field: uint32 rid = 9;
+   */
+  rid: number;
+
   constructor(data?: PartialMessage<EventMetric>);
 
   static readonly runtime: typeof proto3;

package/src/gen/livekit_metrics_pb.js

@@ -16,6 +16,20 @@ export const MetricLabel = /*@__PURE__*/ proto3.makeEnum(
     {no: 0, name: "AGENTS_LLM_TTFT"},
     {no: 1, name: "AGENTS_STT_TTFT"},
     {no: 2, name: "AGENTS_TTS_TTFB"},
+    {no: 3, name: "CLIENT_VIDEO_SUBSCRIBER_FREEZE_COUNT"},
+    {no: 4, name: "CLIENT_VIDEO_SUBSCRIBER_TOTAL_FREEZE_DURATION"},
+    {no: 5, name: "CLIENT_VIDEO_SUBSCRIBER_PAUSE_COUNT"},
+    {no: 6, name: "CLIENT_VIDEO_SUBSCRIBER_TOTAL_PAUSES_DURATION"},
+    {no: 7, name: "CLIENT_AUDIO_SUBSCRIBER_CONCEALED_SAMPLES"},
+    {no: 8, name: "CLIENT_AUDIO_SUBSCRIBER_SILENT_CONCEALED_SAMPLES"},
+    {no: 9, name: "CLIENT_AUDIO_SUBSCRIBER_CONCEALMENT_EVENTS"},
+    {no: 10, name: "CLIENT_AUDIO_SUBSCRIBER_INTERRUPTION_COUNT"},
+    {no: 11, name: "CLIENT_AUDIO_SUBSCRIBER_TOTAL_INTERRUPTION_DURATION"},
+    {no: 12, name: "CLIENT_SUBSCRIBER_JITTER_BUFFER_DELAY"},
+    {no: 13, name: "CLIENT_SUBSCRIBER_JITTER_BUFFER_EMITTED_COUNT"},
+    {no: 14, name: "CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_BANDWIDTH"},
+    {no: 15, name: "CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_CPU"},
+    {no: 16, name: "CLIENT_VIDEO_PUBLISHER_QUALITY_LIMITATION_DURATION_OTHER"},
     {no: 4096, name: "METRIC_LABEL_PREDEFINED_MAX_VALUE"},
   ],
 );
@@ -44,6 +58,7 @@ export const TimeSeriesMetric = /*@__PURE__*/ proto3.makeMessageType(
     { 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: "samples", kind: "message", T: MetricSample, repeated: true },
+    { no: 5, name: "rid", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
   ],
 );
 
@@ -73,6 +88,7 @@ export const EventMetric = /*@__PURE__*/ proto3.makeMessageType(
     { no: 6, name: "normalized_start_timestamp", kind: "message", T: Timestamp },
     { no: 7, name: "normalized_end_timestamp", kind: "message", T: Timestamp, opt: true },
     { no: 8, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 9, name: "rid", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
   ],
 );
 

package/src/gen/livekit_models_pb.d.ts

@@ -1094,6 +1094,24 @@ export declare class DataPacket extends Message<DataPacket> {
      */
     value: ChatMessage;
     case: "chatMessage";
+  } | {
+    /**
+     * @generated from field: livekit.RpcRequest rpc_request = 10;
+     */
+    value: RpcRequest;
+    case: "rpcRequest";
+  } | {
+    /**
+     * @generated from field: livekit.RpcAck rpc_ack = 11;
+     */
+    value: RpcAck;
+    case: "rpcAck";
+  } | {
+    /**
+     * @generated from field: livekit.RpcResponse rpc_response = 12;
+     */
+    value: RpcResponse;
+    case: "rpcResponse";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<DataPacket>);
@@ -1441,6 +1459,149 @@ export declare class ChatMessage extends Message<ChatMessage> {
   static equals(a: ChatMessage | PlainMessage<ChatMessage> | undefined, b: ChatMessage | PlainMessage<ChatMessage> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.RpcRequest
+ */
+export declare class RpcRequest extends Message<RpcRequest> {
+  /**
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * @generated from field: string method = 2;
+   */
+  method: string;
+
+  /**
+   * @generated from field: string payload = 3;
+   */
+  payload: string;
+
+  /**
+   * @generated from field: uint32 response_timeout_ms = 4;
+   */
+  responseTimeoutMs: number;
+
+  /**
+   * @generated from field: uint32 version = 5;
+   */
+  version: number;
+
+  constructor(data?: PartialMessage<RpcRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.RpcRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RpcRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RpcRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RpcRequest;
+
+  static equals(a: RpcRequest | PlainMessage<RpcRequest> | undefined, b: RpcRequest | PlainMessage<RpcRequest> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.RpcAck
+ */
+export declare class RpcAck extends Message<RpcAck> {
+  /**
+   * @generated from field: string request_id = 1;
+   */
+  requestId: string;
+
+  constructor(data?: PartialMessage<RpcAck>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.RpcAck";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RpcAck;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RpcAck;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RpcAck;
+
+  static equals(a: RpcAck | PlainMessage<RpcAck> | undefined, b: RpcAck | PlainMessage<RpcAck> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.RpcResponse
+ */
+export declare class RpcResponse extends Message<RpcResponse> {
+  /**
+   * @generated from field: string request_id = 1;
+   */
+  requestId: string;
+
+  /**
+   * @generated from oneof livekit.RpcResponse.value
+   */
+  value: {
+    /**
+     * @generated from field: string payload = 2;
+     */
+    value: string;
+    case: "payload";
+  } | {
+    /**
+     * @generated from field: livekit.RpcError error = 3;
+     */
+    value: RpcError;
+    case: "error";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<RpcResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.RpcResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RpcResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RpcResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RpcResponse;
+
+  static equals(a: RpcResponse | PlainMessage<RpcResponse> | undefined, b: RpcResponse | PlainMessage<RpcResponse> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.RpcError
+ */
+export declare class RpcError extends Message<RpcError> {
+  /**
+   * @generated from field: uint32 code = 1;
+   */
+  code: number;
+
+  /**
+   * @generated from field: string message = 2;
+   */
+  message: string;
+
+  /**
+   * @generated from field: string data = 3;
+   */
+  data: string;
+
+  constructor(data?: PartialMessage<RpcError>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.RpcError";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): RpcError;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): RpcError;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): RpcError;
+
+  static equals(a: RpcError | PlainMessage<RpcError> | undefined, b: RpcError | PlainMessage<RpcError> | undefined): boolean;
+}
+
 /**
  * @generated from message livekit.ParticipantTracks
  */
@@ -1603,6 +1764,14 @@ export declare class ClientInfo extends Message<ClientInfo> {
    */
   network: string;
 
+  /**
+   * comma separated list of additional LiveKit SDKs in use of this client, with versions
+   * e.g. "components-js:1.2.3,track-processors-js:1.2.3"
+   *
+   * @generated from field: string other_sdks = 11;
+   */
+  otherSdks: string;
+
   constructor(data?: PartialMessage<ClientInfo>);
 
   static readonly runtime: typeof proto3;

package/src/gen/livekit_models_pb.js

@@ -389,6 +389,9 @@ export const DataPacket = /*@__PURE__*/ proto3.makeMessageType(
     { no: 7, name: "transcription", kind: "message", T: Transcription, oneof: "value" },
     { no: 8, name: "metrics", kind: "message", T: MetricsBatch, oneof: "value" },
     { no: 9, name: "chat_message", kind: "message", T: ChatMessage, oneof: "value" },
+    { no: 10, name: "rpc_request", kind: "message", T: RpcRequest, oneof: "value" },
+    { no: 11, name: "rpc_ack", kind: "message", T: RpcAck, oneof: "value" },
+    { no: 12, name: "rpc_response", kind: "message", T: RpcResponse, oneof: "value" },
   ],
 );
 
@@ -496,6 +499,54 @@ export const ChatMessage = /*@__PURE__*/ proto3.makeMessageType(
   ],
 );
 
+/**
+ * @generated from message livekit.RpcRequest
+ */
+export const RpcRequest = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.RpcRequest",
+  () => [
+    { no: 1, name: "id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "method", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "payload", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: "response_timeout_ms", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 5, name: "version", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+  ],
+);
+
+/**
+ * @generated from message livekit.RpcAck
+ */
+export const RpcAck = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.RpcAck",
+  () => [
+    { no: 1, name: "request_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ],
+);
+
+/**
+ * @generated from message livekit.RpcResponse
+ */
+export const RpcResponse = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.RpcResponse",
+  () => [
+    { no: 1, name: "request_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "payload", kind: "scalar", T: 9 /* ScalarType.STRING */, oneof: "value" },
+    { no: 3, name: "error", kind: "message", T: RpcError, oneof: "value" },
+  ],
+);
+
+/**
+ * @generated from message livekit.RpcError
+ */
+export const RpcError = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.RpcError",
+  () => [
+    { no: 1, name: "code", kind: "scalar", T: 13 /* ScalarType.UINT32 */ },
+    { no: 2, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "data", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ],
+);
+
 /**
  * @generated from message livekit.ParticipantTracks
  */
@@ -554,6 +605,7 @@ export const ClientInfo = /*@__PURE__*/ proto3.makeMessageType(
     { no: 8, name: "browser_version", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 9, name: "address", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 10, name: "network", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 11, name: "other_sdks", kind: "scalar", T: 9 /* ScalarType.STRING */ },
   ],
 );
 

package/src/gen/livekit_sip_pb.d.ts

@@ -1246,3 +1246,37 @@ export declare class SIPParticipantInfo extends Message<SIPParticipantInfo> {
   static equals(a: SIPParticipantInfo | PlainMessage<SIPParticipantInfo> | undefined, b: SIPParticipantInfo | PlainMessage<SIPParticipantInfo> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.TransferSIPParticipantRequest
+ */
+export declare class TransferSIPParticipantRequest extends Message<TransferSIPParticipantRequest> {
+  /**
+   * @generated from field: string participant_identity = 1;
+   */
+  participantIdentity: string;
+
+  /**
+   * @generated from field: string room_name = 2;
+   */
+  roomName: string;
+
+  /**
+   * @generated from field: string transfer_to = 3;
+   */
+  transferTo: string;
+
+  constructor(data?: PartialMessage<TransferSIPParticipantRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.TransferSIPParticipantRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransferSIPParticipantRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransferSIPParticipantRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransferSIPParticipantRequest;
+
+  static equals(a: TransferSIPParticipantRequest | PlainMessage<TransferSIPParticipantRequest> | undefined, b: TransferSIPParticipantRequest | PlainMessage<TransferSIPParticipantRequest> | undefined): boolean;
+}
+

package/src/gen/livekit_sip_pb.js

@@ -395,3 +395,15 @@ export const SIPParticipantInfo = /*@__PURE__*/ proto3.makeMessageType(
   ],
 );
 
+/**
+ * @generated from message livekit.TransferSIPParticipantRequest
+ */
+export const TransferSIPParticipantRequest = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.TransferSIPParticipantRequest",
+  () => [
+    { no: 1, name: "participant_identity", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "room_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "transfer_to", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+  ],
+);
+

package/src/gen/version.js

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