@stream-io/video-client 1.18.9 → 1.19.1

package/src/gen/coordinator/index.ts

@@ -726,6 +726,178 @@ export interface CallEvent {
    */
   type: string;
 }
+/**
+ * This event is sent when frame recording has failed
+ * @export
+ * @interface CallFrameRecordingFailedEvent
+ */
+export interface CallFrameRecordingFailedEvent {
+  /**
+   *
+   * @type {CallResponse}
+   * @memberof CallFrameRecordingFailedEvent
+   */
+  call: CallResponse;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFailedEvent
+   */
+  call_cid: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFailedEvent
+   */
+  created_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFailedEvent
+   */
+  egress_id: string;
+  /**
+   * The type of event: "call.frame_recording_failed" in this case
+   * @type {string}
+   * @memberof CallFrameRecordingFailedEvent
+   */
+  type: string;
+}
+/**
+ * This event is sent when a frame is captured from a call
+ * @export
+ * @interface CallFrameRecordingFrameReadyEvent
+ */
+export interface CallFrameRecordingFrameReadyEvent {
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  call_cid: string;
+  /**
+   * The time the frame was captured
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  captured_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  created_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  egress_id: string;
+  /**
+   * Call session ID
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  session_id: string;
+  /**
+   * The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  track_type: string;
+  /**
+   * The type of event: "call.frame_recording_ready" in this case
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  type: string;
+  /**
+   * The URL of the frame
+   * @type {string}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  url: string;
+  /**
+   * The users in the frame
+   * @type {{ [key: string]: UserResponse; }}
+   * @memberof CallFrameRecordingFrameReadyEvent
+   */
+  users: { [key: string]: UserResponse };
+}
+/**
+ * This event is sent when frame recording has started
+ * @export
+ * @interface CallFrameRecordingStartedEvent
+ */
+export interface CallFrameRecordingStartedEvent {
+  /**
+   *
+   * @type {CallResponse}
+   * @memberof CallFrameRecordingStartedEvent
+   */
+  call: CallResponse;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStartedEvent
+   */
+  call_cid: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStartedEvent
+   */
+  created_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStartedEvent
+   */
+  egress_id: string;
+  /**
+   * The type of event: "call.frame_recording_started" in this case
+   * @type {string}
+   * @memberof CallFrameRecordingStartedEvent
+   */
+  type: string;
+}
+/**
+ * This event is sent when frame recording has stopped
+ * @export
+ * @interface CallFrameRecordingStoppedEvent
+ */
+export interface CallFrameRecordingStoppedEvent {
+  /**
+   *
+   * @type {CallResponse}
+   * @memberof CallFrameRecordingStoppedEvent
+   */
+  call: CallResponse;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStoppedEvent
+   */
+  call_cid: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStoppedEvent
+   */
+  created_at: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallFrameRecordingStoppedEvent
+   */
+  egress_id: string;
+  /**
+   * The type of event: "call.frame_recording_stopped" in this case
+   * @type {string}
+   * @memberof CallFrameRecordingStoppedEvent
+   */
+  type: string;
+}
 /**
  * This event is sent when HLS broadcasting has failed
  * @export
@@ -1221,6 +1393,12 @@ export interface CallRecording {
    * @memberof CallRecording
    */
   filename: string;
+  /**
+   *
+   * @type {string}
+   * @memberof CallRecording
+   */
+  session_id: string;
   /**
    *
    * @type {string}
@@ -1389,7 +1567,7 @@ export interface CallRejectedEvent {
    */
   created_at: string;
   /**
-   *
+   * Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy
    * @type {string}
    * @memberof CallRejectedEvent
    */
@@ -3286,6 +3464,12 @@ export interface EgressResponse {
    * @memberof EgressResponse
    */
   broadcasting: boolean;
+  /**
+   *
+   * @type {FrameRecordingResponse}
+   * @memberof EgressResponse
+   */
+  frame_recording?: FrameRecordingResponse;
   /**
    *
    * @type {EgressHLSResponse}
@@ -3312,6 +3496,38 @@ export interface EndCallResponse {
    */
   duration: string;
 }
+/**
+ *
+ * @export
+ * @interface FPSStats
+ */
+export interface FPSStats {
+  /**
+   *
+   * @type {number}
+   * @memberof FPSStats
+   */
+  average_fps: number;
+  /**
+   *
+   * @type {number}
+   * @memberof FPSStats
+   */
+  tracked: number;
+}
+/**
+ *
+ * @export
+ * @interface FrameRecordingResponse
+ */
+export interface FrameRecordingResponse {
+  /**
+   *
+   * @type {string}
+   * @memberof FrameRecordingResponse
+   */
+  status: string;
+}
 /**
  *
  * @export
@@ -3335,7 +3551,7 @@ export interface FrameRecordingSettingsRequest {
    * @type {string}
    * @memberof FrameRecordingSettingsRequest
    */
-  quality?: string;
+  quality?: FrameRecordingSettingsRequestQualityEnum;
 }
 
 /**
@@ -3349,6 +3565,19 @@ export const FrameRecordingSettingsRequestModeEnum = {
 export type FrameRecordingSettingsRequestModeEnum =
   (typeof FrameRecordingSettingsRequestModeEnum)[keyof typeof FrameRecordingSettingsRequestModeEnum];
 
+/**
+ * @export
+ */
+export const FrameRecordingSettingsRequestQualityEnum = {
+  _360P: '360p',
+  _480P: '480p',
+  _720P: '720p',
+  _1080P: '1080p',
+  _1440P: '1440p',
+} as const;
+export type FrameRecordingSettingsRequestQualityEnum =
+  (typeof FrameRecordingSettingsRequestQualityEnum)[keyof typeof FrameRecordingSettingsRequestQualityEnum];
+
 /**
  *
  * @export
@@ -3558,6 +3787,12 @@ export interface GetCallStatsResponse {
    * @memberof GetCallStatsResponse
    */
   duration: string;
+  /**
+   *
+   * @type {boolean}
+   * @memberof GetCallStatsResponse
+   */
+  is_truncated_report: boolean;
   /**
    *
    * @type {TimeStats}
@@ -5381,19 +5616,19 @@ export interface Response {
  */
 export interface RingSettingsRequest {
   /**
-   *
+   * When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs
    * @type {number}
    * @memberof RingSettingsRequest
    */
   auto_cancel_timeout_ms: number;
   /**
-   *
+   * When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs
    * @type {number}
    * @memberof RingSettingsRequest
    */
   incoming_call_timeout_ms: number;
   /**
-   *
+   * When a callee doesn't accept or reject a ring call in this time a missed call event will be sent
    * @type {number}
    * @memberof RingSettingsRequest
    */
@@ -5850,6 +6085,12 @@ export interface StartTranscriptionResponse {
  * @interface StatsOptions
  */
 export interface StatsOptions {
+  /**
+   *
+   * @type {boolean}
+   * @memberof StatsOptions
+   */
+  enable_rtc_stats: boolean;
   /**
    *
    * @type {number}
@@ -6972,6 +7213,12 @@ export interface UserSessionStats {
    * @memberof UserSessionStats
    */
   distance_to_sfu_kilometers?: number;
+  /**
+   *
+   * @type {FPSStats}
+   * @memberof UserSessionStats
+   */
+  fps?: FPSStats;
   /**
    *
    * @type {number}
@@ -7245,6 +7492,12 @@ export interface UserSessionStats {
  * @interface UserStats
  */
 export interface UserStats {
+  /**
+   *
+   * @type {string}
+   * @memberof UserStats
+   */
+  feedback?: string;
   /**
    *
    * @type {UserInfoResponse}
@@ -7341,6 +7594,10 @@ export type VideoEvent =
   | ({ type: 'call.created' } & CallCreatedEvent)
   | ({ type: 'call.deleted' } & CallDeletedEvent)
   | ({ type: 'call.ended' } & CallEndedEvent)
+  | ({ type: 'call.frame_recording_failed' } & CallFrameRecordingFailedEvent)
+  | ({ type: 'call.frame_recording_ready' } & CallFrameRecordingFrameReadyEvent)
+  | ({ type: 'call.frame_recording_started' } & CallFrameRecordingStartedEvent)
+  | ({ type: 'call.frame_recording_stopped' } & CallFrameRecordingStoppedEvent)
   | ({ type: 'call.hls_broadcasting_failed' } & CallHLSBroadcastingFailedEvent)
   | ({
       type: 'call.hls_broadcasting_started';

package/src/gen/google/protobuf/struct.ts

@@ -1,5 +1,11 @@
 /* eslint-disable */
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+import type {
+  JsonObject,
+  JsonReadOptions,
+  JsonValue,
+  JsonWriteOptions,
+} from '@protobuf-ts/runtime';
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "google/protobuf/struct.proto" (package "google.protobuf", syntax proto3)
 // tslint:disable
 //
@@ -33,13 +39,12 @@
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 //
-import { isJsonObject } from '@protobuf-ts/runtime';
-import { typeofJsonValue } from '@protobuf-ts/runtime';
-import type { JsonValue } from '@protobuf-ts/runtime';
-import type { JsonReadOptions } from '@protobuf-ts/runtime';
-import type { JsonWriteOptions } from '@protobuf-ts/runtime';
-import type { JsonObject } from '@protobuf-ts/runtime';
-import { MessageType } from '@protobuf-ts/runtime';
+import {
+  isJsonObject,
+  MessageType,
+  typeofJsonValue,
+} from '@protobuf-ts/runtime';
+
 /**
  * `Struct` represents a structured data value, consisting of fields
  * which map to dynamically typed values. In some languages, `Struct`

package/src/gen/google/protobuf/timestamp.ts

@@ -1,5 +1,10 @@
 /* eslint-disable */
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+import type {
+  JsonReadOptions,
+  JsonValue,
+  JsonWriteOptions,
+} from '@protobuf-ts/runtime';
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "google/protobuf/timestamp.proto" (package "google.protobuf", syntax proto3)
 // tslint:disable
 //
@@ -33,12 +38,8 @@
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 //
-import { typeofJsonValue } from '@protobuf-ts/runtime';
-import type { JsonValue } from '@protobuf-ts/runtime';
-import type { JsonReadOptions } from '@protobuf-ts/runtime';
-import type { JsonWriteOptions } from '@protobuf-ts/runtime';
-import { PbLong } from '@protobuf-ts/runtime';
-import { MessageType } from '@protobuf-ts/runtime';
+import { MessageType, PbLong, typeofJsonValue } from '@protobuf-ts/runtime';
+
 /**
  * A Timestamp represents a point in time independent of any time zone or local
  * calendar, encoded as a count of seconds and fractions of seconds at
@@ -189,7 +190,8 @@ class Timestamp$Type extends MessageType<Timestamp> {
     const msg = this.create();
     const ms = date.getTime();
     msg.seconds = PbLong.from(Math.floor(ms / 1000)).toString();
-    msg.nanos = (ms % 1000) * 1000000;
+    msg.nanos =
+      ((ms % 1000) + (ms < 0 && ms % 1000 !== 0 ? 1000 : 0)) * 1000000;
     return msg;
   }
   /**

package/src/gen/video/sfu/event/events.ts

@@ -1,4 +1,4 @@
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/event/events.proto" (package "stream.video.sfu.event", syntax proto3)
 // tslint:disable
 import { MessageType } from '@protobuf-ts/runtime';
@@ -539,6 +539,12 @@ export interface ReconnectDetails {
    * @generated from protobuf field: string previous_session_id = 7;
    */
   previousSessionId: string;
+  /**
+   * the reconnect reason
+   *
+   * @generated from protobuf field: string reason = 8;
+   */
+  reason: string;
 }
 /**
  * @generated from protobuf message stream.video.sfu.event.Migration
@@ -1389,6 +1395,7 @@ class ReconnectDetails$Type extends MessageType<ReconnectDetails> {
         kind: 'scalar',
         T: 9 /*ScalarType.STRING*/,
       },
+      { no: 8, name: 'reason', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
     ]);
   }
 }

package/src/gen/video/sfu/models/models.ts

@@ -1,4 +1,4 @@
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/models/models.proto" (package "stream.video.sfu.models", syntax proto3)
 // tslint:disable
 import { MessageType } from '@protobuf-ts/runtime';
@@ -468,6 +468,45 @@ export interface Browser {
    */
   version: string;
 }
+/**
+ * @generated from protobuf message stream.video.sfu.models.RTMPIngress
+ */
+export interface RTMPIngress {
+  /**
+   * Video dimensions and frame rate
+   *
+   * @generated from protobuf field: uint32 width = 1;
+   */
+  width: number;
+  /**
+   * @generated from protobuf field: uint32 height = 2;
+   */
+  height: number;
+  /**
+   * @generated from protobuf field: double frame_rate = 3;
+   */
+  frameRate: number;
+  /**
+   * Client info
+   *
+   * @generated from protobuf field: string software = 4;
+   */
+  software: string; // e.g. "obs-studio"
+  /**
+   * @generated from protobuf field: string version = 5;
+   */
+  version: string; // e.g. "29.1.3"
+  /**
+   * @generated from protobuf field: string encoder = 6;
+   */
+  encoder: string; // e.g. "x264" or "NVIDIA NVENC"
+  /**
+   * Connection info
+   *
+   * @generated from protobuf field: string remote_addr = 7;
+   */
+  remoteAddr: string;
+}
 /**
  * @generated from protobuf message stream.video.sfu.models.Device
  */
@@ -1426,6 +1465,29 @@ class Browser$Type extends MessageType<Browser> {
  */
 export const Browser = new Browser$Type();
 // @generated message type with reflection information, may provide speed optimized methods
+class RTMPIngress$Type extends MessageType<RTMPIngress> {
+  constructor() {
+    super('stream.video.sfu.models.RTMPIngress', [
+      { no: 1, name: 'width', kind: 'scalar', T: 13 /*ScalarType.UINT32*/ },
+      { no: 2, name: 'height', kind: 'scalar', T: 13 /*ScalarType.UINT32*/ },
+      { no: 3, name: 'frame_rate', kind: 'scalar', T: 1 /*ScalarType.DOUBLE*/ },
+      { no: 4, name: 'software', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+      { no: 5, name: 'version', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+      { no: 6, name: 'encoder', kind: 'scalar', T: 9 /*ScalarType.STRING*/ },
+      {
+        no: 7,
+        name: 'remote_addr',
+        kind: 'scalar',
+        T: 9 /*ScalarType.STRING*/,
+      },
+    ]);
+  }
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.RTMPIngress
+ */
+export const RTMPIngress = new RTMPIngress$Type();
+// @generated message type with reflection information, may provide speed optimized methods
 class Device$Type extends MessageType<Device> {
   constructor() {
     super('stream.video.sfu.models.Device', [

package/src/gen/video/sfu/signal_rpc/signal.client.ts

@@ -1,4 +1,4 @@
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable
 import type {

package/src/gen/video/sfu/signal_rpc/signal.ts

@@ -1,4 +1,4 @@
-// @generated by protobuf-ts 2.9.4 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
+// @generated by protobuf-ts 2.9.6 with parameter long_type_string,client_generic,server_none,eslint_disable,optimize_code_size
 // @generated from protobuf file "video/sfu/signal_rpc/signal.proto" (package "stream.video.sfu.signal", syntax proto3)
 // tslint:disable
 import {
@@ -8,6 +8,7 @@ import {
   ICETrickle,
   InputDevices,
   PeerType,
+  RTMPIngress,
   TrackInfo,
   TrackType,
   VideoDimension,
@@ -152,6 +153,18 @@ export interface SendStatsRequest {
    * @generated from protobuf field: stream.video.sfu.signal.Telemetry telemetry = 11;
    */
   telemetry?: Telemetry;
+  /**
+   * @generated from protobuf field: stream.video.sfu.models.RTMPIngress rtmp = 12;
+   */
+  rtmp?: RTMPIngress;
+  /**
+   * @generated from protobuf field: string subscriber_rtc_stats = 13;
+   */
+  subscriberRtcStats: string;
+  /**
+   * @generated from protobuf field: string publisher_rtc_stats = 14;
+   */
+  publisherRtcStats: string;
 }
 /**
  * @generated from protobuf message stream.video.sfu.signal.SendStatsResponse
@@ -508,6 +521,19 @@ class SendStatsRequest$Type extends MessageType<SendStatsRequest> {
         T: () => AppleState,
       },
       { no: 11, name: 'telemetry', kind: 'message', T: () => Telemetry },
+      { no: 12, name: 'rtmp', kind: 'message', T: () => RTMPIngress },
+      {
+        no: 13,
+        name: 'subscriber_rtc_stats',
+        kind: 'scalar',
+        T: 9 /*ScalarType.STRING*/,
+      },
+      {
+        no: 14,
+        name: 'publisher_rtc_stats',
+        kind: 'scalar',
+        T: 9 /*ScalarType.STRING*/,
+      },
     ]);
   }
 }

package/src/rpc/__tests__/createClient.test.ts

@@ -3,6 +3,7 @@ import {
   createSignalClient,
   withHeaders,
   withRequestLogger,
+  withRequestTracer,
 } from '../createClient';
 import { TwirpFetchTransport } from '@protobuf-ts/twirp-transport';
 
@@ -35,4 +36,41 @@ describe('createClient', () => {
     expect(next).toHaveBeenCalled();
     expect(logger).toHaveBeenCalled();
   });
+
+  it('withRequestTracer should add trace to the request', () => {
+    const trace = vi.fn();
+    const interceptor = withRequestTracer(trace);
+    const next = vi.fn();
+    interceptor.interceptUnary(
+      next,
+      // @ts-expect-error - invalid name
+      { name: 'TestMethod' },
+      { param: 'value' },
+      { meta: {} },
+    );
+    expect(next).toHaveBeenCalled();
+    expect(trace).toHaveBeenCalledWith('TestMethod', { param: 'value' });
+  });
+
+  it('withRequestTracer should add an error trace', () => {
+    const trace = vi.fn();
+    const interceptor = withRequestTracer(trace);
+    const err = new Error('test error');
+    const next = vi.fn(() => {
+      throw err;
+    });
+    expect(() =>
+      interceptor.interceptUnary(
+        next,
+        // @ts-expect-error - invalid name
+        { name: 'TestMethod' },
+        { param: 'value' },
+        { meta: {} },
+      ),
+    ).toThrow('test error');
+    expect(trace).toHaveBeenLastCalledWith('TestMethodOnFailure', [
+      { param: 'value' },
+      err,
+    ]);
+  });
 });

package/src/rpc/createClient.ts

@@ -11,6 +11,7 @@ import {
 } from '@protobuf-ts/twirp-transport';
 import { SignalServerClient } from '../gen/video/sfu/signal_rpc/signal.client';
 import { Logger, LogLevel } from '../coordinator/connection/types';
+import type { Trace } from '../stats/rtc/types';
 
 const defaultOptions: TwirpOptions = {
   baseUrl: '',
@@ -63,6 +64,35 @@ export const withRequestLogger = (
   };
 };
 
+export const withRequestTracer = (trace: Trace): RpcInterceptor => {
+  type RpcMethodNames = {
+    [K in keyof SignalServerClient as Capitalize<K>]: boolean;
+  };
+
+  const exclusions: Record<string, boolean | undefined> = {
+    SendStats: true,
+  } satisfies Partial<RpcMethodNames>;
+  return {
+    interceptUnary(
+      next: NextUnaryFn,
+      method: MethodInfo,
+      input: object,
+      options: RpcOptions,
+    ): UnaryCall {
+      if (exclusions[method.name as keyof RpcMethodNames]) {
+        return next(method, input, options);
+      }
+      try {
+        trace(method.name, input);
+        return next(method, input, options);
+      } catch (err) {
+        trace(`${method.name}OnFailure`, [input, err]);
+        throw err;
+      }
+    },
+  };
+};
+
 /**
  * Creates new SignalServerClient instance.
  *