@livekit/protocol 1.33.0 → 1.35.0

package/dist/index.d.cts

@@ -1225,6 +1225,13 @@ declare enum ParticipantInfo_Kind {
    * @generated from enum value: AGENT = 4;
    */
   AGENT = 4,
+
+  /**
+   * forwarded participant from another room
+   *
+   * @generated from enum value: FORWARDED = 5;
+   */
+  FORWARDED = 5,
 }
 
 /**
@@ -3341,6 +3348,11 @@ declare enum JobType {
    * @generated from enum value: JT_PUBLISHER = 1;
    */
   JT_PUBLISHER = 1,
+
+  /**
+   * @generated from enum value: JT_PARTICIPANT = 2;
+   */
+  JT_PARTICIPANT = 2,
 }
 
 /**
@@ -4397,6 +4409,32 @@ declare enum StreamProtocol {
   SRT = 2,
 }
 
+/**
+ * @generated from enum livekit.AudioMixing
+ */
+declare enum AudioMixing {
+  /**
+   * all users are mixed together
+   *
+   * @generated from enum value: DEFAULT_MIXING = 0;
+   */
+  DEFAULT_MIXING = 0,
+
+  /**
+   * agent audio in the left channel, all other audio in the right channel
+   *
+   * @generated from enum value: DUAL_CHANNEL_AGENT = 1;
+   */
+  DUAL_CHANNEL_AGENT = 1,
+
+  /**
+   * each new audio track alternates between left and right channels
+   *
+   * @generated from enum value: DUAL_CHANNEL_ALTERNATE = 2;
+   */
+  DUAL_CHANNEL_ALTERNATE = 2,
+}
+
 /**
  * @generated from enum livekit.EncodingOptionsPreset
  */
@@ -4540,6 +4578,13 @@ declare class RoomCompositeEgressRequest extends Message<RoomCompositeEgressRequ
    */
   audioOnly: boolean;
 
+  /**
+   * only applies to audio_only egress (default DEFAULT_MIXING)
+   *
+   * @generated from field: livekit.AudioMixing audio_mixing = 15;
+   */
+  audioMixing: AudioMixing;
+
   /**
    * (default false)
    *
@@ -7990,6 +8035,65 @@ declare class RoomConfiguration extends Message<RoomConfiguration> {
   static equals(a: RoomConfiguration | PlainMessage<RoomConfiguration> | undefined, b: RoomConfiguration | PlainMessage<RoomConfiguration> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.ForwardParticipantRequest
+ */
+declare class ForwardParticipantRequest extends Message<ForwardParticipantRequest> {
+  /**
+   * room to forward participant from
+   *
+   * @generated from field: string room = 1;
+   */
+  room: string;
+
+  /**
+   * identity of the participant to forward
+   *
+   * @generated from field: string identity = 2;
+   */
+  identity: string;
+
+  /**
+   * room to forward participant to
+   *
+   * @generated from field: string destination_room = 3;
+   */
+  destinationRoom: string;
+
+  constructor(data?: PartialMessage<ForwardParticipantRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ForwardParticipantRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ForwardParticipantRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ForwardParticipantRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ForwardParticipantRequest;
+
+  static equals(a: ForwardParticipantRequest | PlainMessage<ForwardParticipantRequest> | undefined, b: ForwardParticipantRequest | PlainMessage<ForwardParticipantRequest> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.ForwardParticipantResponse
+ */
+declare class ForwardParticipantResponse extends Message<ForwardParticipantResponse> {
+  constructor(data?: PartialMessage<ForwardParticipantResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.ForwardParticipantResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ForwardParticipantResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ForwardParticipantResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ForwardParticipantResponse;
+
+  static equals(a: ForwardParticipantResponse | PlainMessage<ForwardParticipantResponse> | undefined, b: ForwardParticipantResponse | PlainMessage<ForwardParticipantResponse> | undefined): boolean;
+}
+
 // Copyright 2023 LiveKit, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -11686,6 +11790,68 @@ declare class DeleteSIPDispatchRuleRequest extends Message<DeleteSIPDispatchRule
   static equals(a: DeleteSIPDispatchRuleRequest | PlainMessage<DeleteSIPDispatchRuleRequest> | undefined, b: DeleteSIPDispatchRuleRequest | PlainMessage<DeleteSIPDispatchRuleRequest> | undefined): boolean;
 }
 
+/**
+ * @generated from message livekit.SIPOutboundConfig
+ */
+declare class SIPOutboundConfig extends Message<SIPOutboundConfig> {
+  /**
+   * SIP server address
+   *
+   * @generated from field: string hostname = 1;
+   */
+  hostname: string;
+
+  /**
+   * SIP Transport used for outbound call.
+   *
+   * @generated from field: livekit.SIPTransport transport = 2;
+   */
+  transport: SIPTransport;
+
+  /**
+   * Username and password used to authenticate with SIP server.
+   * May be empty to have no authentication.
+   *
+   * @generated from field: string auth_username = 3;
+   */
+  authUsername: string;
+
+  /**
+   * @generated from field: string auth_password = 4;
+   */
+  authPassword: string;
+
+  /**
+   * Map SIP X-* headers from 200 OK to SIP participant attributes.
+   * Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
+   *
+   * @generated from field: map<string, string> headers_to_attributes = 5;
+   */
+  headersToAttributes: { [key: string]: string };
+
+  /**
+   * Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
+   * Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
+   *
+   * @generated from field: map<string, string> attributes_to_headers = 6;
+   */
+  attributesToHeaders: { [key: string]: string };
+
+  constructor(data?: PartialMessage<SIPOutboundConfig>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.SIPOutboundConfig";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SIPOutboundConfig;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SIPOutboundConfig;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SIPOutboundConfig;
+
+  static equals(a: SIPOutboundConfig | PlainMessage<SIPOutboundConfig> | undefined, b: SIPOutboundConfig | PlainMessage<SIPOutboundConfig> | undefined): boolean;
+}
+
 /**
  * A SIP Participant is a singular SIP session connected to a LiveKit room via
  * a SIP Trunk into a SIP DispatchRule
@@ -11700,6 +11866,11 @@ declare class CreateSIPParticipantRequest extends Message<CreateSIPParticipantRe
    */
   sipTrunkId: string;
 
+  /**
+   * @generated from field: livekit.SIPOutboundConfig trunk = 20;
+   */
+  trunk?: SIPOutboundConfig;
+
   /**
    * What number should be dialed via SIP
    *
@@ -11826,7 +11997,7 @@ declare class CreateSIPParticipantRequest extends Message<CreateSIPParticipantRe
   /**
    * Wait for the answer for the call before returning.
    *
-   * NEXT ID: 20
+   * NEXT ID: 21
    *
    * @generated from field: bool wait_until_answered = 19;
    */
@@ -11948,6 +12119,16 @@ declare class SIPCallInfo extends Message<SIPCallInfo> {
    */
   trunkId: string;
 
+  /**
+   * @generated from field: string dispatch_rule_id = 16;
+   */
+  dispatchRuleId: string;
+
+  /**
+   * @generated from field: string region = 17;
+   */
+  region: string;
+
   /**
    * @generated from field: string room_name = 3;
    */
@@ -11965,6 +12146,11 @@ declare class SIPCallInfo extends Message<SIPCallInfo> {
    */
   participantIdentity: string;
 
+  /**
+   * @generated from field: map<string, string> participant_attributes = 18;
+   */
+  participantAttributes: { [key: string]: string };
+
   /**
    * @generated from field: livekit.SIPUri from_uri = 6;
    */
@@ -11975,6 +12161,24 @@ declare class SIPCallInfo extends Message<SIPCallInfo> {
    */
   toUri?: SIPUri;
 
+  /**
+   * @generated from field: int64 created_at = 9 [deprecated = true];
+   * @deprecated
+   */
+  createdAt: bigint;
+
+  /**
+   * @generated from field: int64 started_at = 10 [deprecated = true];
+   * @deprecated
+   */
+  startedAt: bigint;
+
+  /**
+   * @generated from field: int64 ended_at = 11 [deprecated = true];
+   * @deprecated
+   */
+  endedAt: bigint;
+
   /**
    * @generated from field: repeated livekit.SIPFeature enabled_features = 14;
    */
@@ -11991,19 +12195,19 @@ declare class SIPCallInfo extends Message<SIPCallInfo> {
   callStatus: SIPCallStatus;
 
   /**
-   * @generated from field: int64 created_at = 9;
+   * @generated from field: int64 created_at_ns = 22;
    */
-  createdAt: bigint;
+  createdAtNs: bigint;
 
   /**
-   * @generated from field: int64 started_at = 10;
+   * @generated from field: int64 started_at_ns = 23;
    */
-  startedAt: bigint;
+  startedAtNs: bigint;
 
   /**
-   * @generated from field: int64 ended_at = 11;
+   * @generated from field: int64 ended_at_ns = 24;
    */
-  endedAt: bigint;
+  endedAtNs: bigint;
 
   /**
    * @generated from field: livekit.DisconnectReason disconnect_reason = 12;
@@ -12015,6 +12219,21 @@ declare class SIPCallInfo extends Message<SIPCallInfo> {
    */
   error: string;
 
+  /**
+   * @generated from field: livekit.SIPStatus call_status_code = 19;
+   */
+  callStatusCode?: SIPStatus;
+
+  /**
+   * @generated from field: string audio_codec = 20;
+   */
+  audioCodec: string;
+
+  /**
+   * @generated from field: string media_encryption = 21;
+   */
+  mediaEncryption: string;
+
   constructor(data?: PartialMessage<SIPCallInfo>);
 
   static readonly runtime: typeof proto3;
@@ -12151,7 +12370,8 @@ declare class WebhookEvent extends Message<WebhookEvent> {
   createdAt: bigint;
 
   /**
-   * @generated from field: int32 num_dropped = 11;
+   * @generated from field: int32 num_dropped = 11 [deprecated = true];
+   * @deprecated
    */
   numDropped: number;
 
@@ -12172,4 +12392,4 @@ declare class WebhookEvent extends Message<WebhookEvent> {
 
 declare const version: string;
 
-export { ActiveSpeakerUpdate, AddTrackRequest, AgentDispatch, AgentDispatchState, AliOSSUpload, AudioCodec, AudioTrackFeature, AutoParticipantEgress, AutoTrackEgress, AvailabilityRequest, AvailabilityResponse, AzureBlobUpload, BackupCodecPolicy, CandidateProtocol, ChatMessage, ClientConfigSetting, ClientConfiguration, ClientInfo, ClientInfo_SDK, Codec, ConnectionQuality, ConnectionQualityInfo, ConnectionQualityUpdate, CreateAgentDispatchRequest, CreateIngressRequest, CreateRoomRequest, CreateSIPDispatchRuleRequest, CreateSIPInboundTrunkRequest, CreateSIPOutboundTrunkRequest, CreateSIPParticipantRequest, CreateSIPTrunkRequest, DataChannelInfo, DataPacket, DataPacket_Kind, DataStream, DataStream_ByteHeader, DataStream_Chunk, DataStream_Header, DataStream_OperationType, DataStream_TextHeader, DataStream_Trailer, DeleteAgentDispatchRequest, DeleteIngressRequest, DeleteRoomRequest, DeleteRoomResponse, DeleteSIPDispatchRuleRequest, DeleteSIPTrunkRequest, DirectFileOutput, DisabledCodecs, DisconnectReason, EgressInfo, EgressSourceType, EgressStatus, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, Encryption, Encryption_Type, EventMetric, FileInfo, GCPUpload, GetSIPInboundTrunkRequest, GetSIPInboundTrunkResponse, GetSIPOutboundTrunkRequest, GetSIPOutboundTrunkResponse, ICEServer, ImageCodec, ImageFileSuffix, ImageOutput, ImagesInfo, IngressAudioEncodingOptions, IngressAudioEncodingPreset, IngressAudioOptions, IngressInfo, IngressInput, IngressState, IngressState_Status, IngressVideoEncodingOptions, IngressVideoEncodingPreset, IngressVideoOptions, InputAudioState, InputVideoState, Job, JobAssignment, JobState, JobStatus, JobTermination, JobType, JoinResponse, LeaveRequest, LeaveRequest_Action, ListAgentDispatchRequest, ListAgentDispatchResponse, ListEgressRequest, ListEgressResponse, ListIngressRequest, ListIngressResponse, ListParticipantsRequest, ListParticipantsResponse, ListRoomsRequest, ListRoomsResponse, ListSIPDispatchRuleRequest, ListSIPDispatchRuleResponse, ListSIPInboundTrunkRequest, ListSIPInboundTrunkResponse, ListSIPOutboundTrunkRequest, ListSIPOutboundTrunkResponse, ListSIPTrunkRequest, ListSIPTrunkResponse, MetricLabel, MetricSample, MetricsBatch, MigrateJobRequest, MuteRoomTrackRequest, MuteRoomTrackResponse, MuteTrackRequest, Pagination, ParticipantEgressRequest, ParticipantInfo, ParticipantInfo_Kind, ParticipantInfo_State, ParticipantPermission, ParticipantTracks, ParticipantUpdate, Ping, PlayoutDelay, Pong, ProxyConfig, RTCPSenderReportState, RTPDrift, RTPForwarderState, RTPMungerState, RTPStats, ReconnectReason, ReconnectResponse, RegionInfo, RegionSettings, RegisterWorkerRequest, RegisterWorkerResponse, RemoveParticipantResponse, RequestResponse, RequestResponse_Reason, Room, RoomAgent, RoomAgentDispatch, RoomCompositeEgressRequest, RoomConfiguration, RoomEgress, RoomParticipantIdentity, RoomUpdate, RpcAck, RpcError, RpcRequest, RpcResponse, S3Upload, SIPCallDirection, SIPCallInfo, SIPCallStatus, SIPDispatchRule, SIPDispatchRuleCallee, SIPDispatchRuleDirect, SIPDispatchRuleIndividual, SIPDispatchRuleInfo, SIPFeature, SIPHeaderOptions, SIPInboundTrunkInfo, SIPMediaEncryption, SIPOutboundTrunkInfo, SIPParticipantInfo, SIPStatus, SIPStatusCode, SIPTransport, SIPTrunkInfo, SIPTrunkInfo_TrunkKind, SIPUri, SegmentedFileOutput, SegmentedFileProtocol, SegmentedFileSuffix, SegmentsInfo, SendDataRequest, SendDataResponse, ServerInfo, ServerInfo_Edition, ServerMessage, SessionDescription, SignalRequest, SignalResponse, SignalTarget, SimulateJobRequest, SimulateScenario, SimulcastCodec, SimulcastCodecInfo, SipDTMF, SpeakerInfo, SpeakersChanged, StopEgressRequest, StreamInfo, StreamInfoList, StreamInfo_Status, StreamOutput, StreamProtocol, StreamState, StreamStateInfo, StreamStateUpdate, SubscribedCodec, SubscribedQuality, SubscribedQualityUpdate, SubscriptionError, SubscriptionPermission, SubscriptionPermissionUpdate, SubscriptionResponse, SyncState, TimeSeriesMetric, TimedVersion, TrackCompositeEgressRequest, TrackEgressRequest, TrackInfo, TrackPermission, TrackPublishedResponse, TrackSource, TrackSubscribed, TrackType, TrackUnpublishedResponse, Transcription, TranscriptionSegment, TransferSIPParticipantRequest, TrickleRequest, UpdateIngressRequest, UpdateJobStatus, UpdateLayoutRequest, UpdateLocalAudioTrack, UpdateLocalVideoTrack, UpdateParticipantMetadata, UpdateParticipantRequest, UpdateRoomMetadataRequest, UpdateStreamRequest, UpdateSubscription, UpdateSubscriptionsRequest, UpdateSubscriptionsResponse, UpdateTrackSettings, UpdateVideoLayers, UpdateWorkerStatus, UserPacket, VP8MungerState, VideoCodec, VideoConfiguration, VideoLayer, VideoQuality, WebEgressRequest, WebhookEvent, WorkerMessage, WorkerPing, WorkerPong, WorkerStatus, version };
+export { ActiveSpeakerUpdate, AddTrackRequest, AgentDispatch, AgentDispatchState, AliOSSUpload, AudioCodec, AudioMixing, AudioTrackFeature, AutoParticipantEgress, AutoTrackEgress, AvailabilityRequest, AvailabilityResponse, AzureBlobUpload, BackupCodecPolicy, CandidateProtocol, ChatMessage, ClientConfigSetting, ClientConfiguration, ClientInfo, ClientInfo_SDK, Codec, ConnectionQuality, ConnectionQualityInfo, ConnectionQualityUpdate, CreateAgentDispatchRequest, CreateIngressRequest, CreateRoomRequest, CreateSIPDispatchRuleRequest, CreateSIPInboundTrunkRequest, CreateSIPOutboundTrunkRequest, CreateSIPParticipantRequest, CreateSIPTrunkRequest, DataChannelInfo, DataPacket, DataPacket_Kind, DataStream, DataStream_ByteHeader, DataStream_Chunk, DataStream_Header, DataStream_OperationType, DataStream_TextHeader, DataStream_Trailer, DeleteAgentDispatchRequest, DeleteIngressRequest, DeleteRoomRequest, DeleteRoomResponse, DeleteSIPDispatchRuleRequest, DeleteSIPTrunkRequest, DirectFileOutput, DisabledCodecs, DisconnectReason, EgressInfo, EgressSourceType, EgressStatus, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, Encryption, Encryption_Type, EventMetric, FileInfo, ForwardParticipantRequest, ForwardParticipantResponse, GCPUpload, GetSIPInboundTrunkRequest, GetSIPInboundTrunkResponse, GetSIPOutboundTrunkRequest, GetSIPOutboundTrunkResponse, ICEServer, ImageCodec, ImageFileSuffix, ImageOutput, ImagesInfo, IngressAudioEncodingOptions, IngressAudioEncodingPreset, IngressAudioOptions, IngressInfo, IngressInput, IngressState, IngressState_Status, IngressVideoEncodingOptions, IngressVideoEncodingPreset, IngressVideoOptions, InputAudioState, InputVideoState, Job, JobAssignment, JobState, JobStatus, JobTermination, JobType, JoinResponse, LeaveRequest, LeaveRequest_Action, ListAgentDispatchRequest, ListAgentDispatchResponse, ListEgressRequest, ListEgressResponse, ListIngressRequest, ListIngressResponse, ListParticipantsRequest, ListParticipantsResponse, ListRoomsRequest, ListRoomsResponse, ListSIPDispatchRuleRequest, ListSIPDispatchRuleResponse, ListSIPInboundTrunkRequest, ListSIPInboundTrunkResponse, ListSIPOutboundTrunkRequest, ListSIPOutboundTrunkResponse, ListSIPTrunkRequest, ListSIPTrunkResponse, MetricLabel, MetricSample, MetricsBatch, MigrateJobRequest, MuteRoomTrackRequest, MuteRoomTrackResponse, MuteTrackRequest, Pagination, ParticipantEgressRequest, ParticipantInfo, ParticipantInfo_Kind, ParticipantInfo_State, ParticipantPermission, ParticipantTracks, ParticipantUpdate, Ping, PlayoutDelay, Pong, ProxyConfig, RTCPSenderReportState, RTPDrift, RTPForwarderState, RTPMungerState, RTPStats, ReconnectReason, ReconnectResponse, RegionInfo, RegionSettings, RegisterWorkerRequest, RegisterWorkerResponse, RemoveParticipantResponse, RequestResponse, RequestResponse_Reason, Room, RoomAgent, RoomAgentDispatch, RoomCompositeEgressRequest, RoomConfiguration, RoomEgress, RoomParticipantIdentity, RoomUpdate, RpcAck, RpcError, RpcRequest, RpcResponse, S3Upload, SIPCallDirection, SIPCallInfo, SIPCallStatus, SIPDispatchRule, SIPDispatchRuleCallee, SIPDispatchRuleDirect, SIPDispatchRuleIndividual, SIPDispatchRuleInfo, SIPFeature, SIPHeaderOptions, SIPInboundTrunkInfo, SIPMediaEncryption, SIPOutboundConfig, SIPOutboundTrunkInfo, SIPParticipantInfo, SIPStatus, SIPStatusCode, SIPTransport, SIPTrunkInfo, SIPTrunkInfo_TrunkKind, SIPUri, SegmentedFileOutput, SegmentedFileProtocol, SegmentedFileSuffix, SegmentsInfo, SendDataRequest, SendDataResponse, ServerInfo, ServerInfo_Edition, ServerMessage, SessionDescription, SignalRequest, SignalResponse, SignalTarget, SimulateJobRequest, SimulateScenario, SimulcastCodec, SimulcastCodecInfo, SipDTMF, SpeakerInfo, SpeakersChanged, StopEgressRequest, StreamInfo, StreamInfoList, StreamInfo_Status, StreamOutput, StreamProtocol, StreamState, StreamStateInfo, StreamStateUpdate, SubscribedCodec, SubscribedQuality, SubscribedQualityUpdate, SubscriptionError, SubscriptionPermission, SubscriptionPermissionUpdate, SubscriptionResponse, SyncState, TimeSeriesMetric, TimedVersion, TrackCompositeEgressRequest, TrackEgressRequest, TrackInfo, TrackPermission, TrackPublishedResponse, TrackSource, TrackSubscribed, TrackType, TrackUnpublishedResponse, Transcription, TranscriptionSegment, TransferSIPParticipantRequest, TrickleRequest, UpdateIngressRequest, UpdateJobStatus, UpdateLayoutRequest, UpdateLocalAudioTrack, UpdateLocalVideoTrack, UpdateParticipantMetadata, UpdateParticipantRequest, UpdateRoomMetadataRequest, UpdateStreamRequest, UpdateSubscription, UpdateSubscriptionsRequest, UpdateSubscriptionsResponse, UpdateTrackSettings, UpdateVideoLayers, UpdateWorkerStatus, UserPacket, VP8MungerState, VideoCodec, VideoConfiguration, VideoLayer, VideoQuality, WebEgressRequest, WebhookEvent, WorkerMessage, WorkerPing, WorkerPong, WorkerStatus, version };