@stream-io/video-client 1.10.5 → 1.11.0

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

@@ -1,4 +1,6 @@
-import type { JsonReadOptions, JsonValue, JsonWriteOptions } 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 { MessageType } from '@protobuf-ts/runtime';
 /**
  * `Struct` represents a structured data value, consisting of fields

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

@@ -1,4 +1,6 @@
-import type { JsonReadOptions, JsonValue, JsonWriteOptions } 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 { MessageType } from '@protobuf-ts/runtime';
 /**
  * A Timestamp represents a point in time independent of any time zone or local

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

@@ -1,6 +1,24 @@
 import { MessageType } from '@protobuf-ts/runtime';
-import { CallEndedReason, CallGrants, CallState, ClientDetails, Codec, ConnectionQuality, Error as Error$, GoAwayReason, ICETrickle as ICETrickle$, Participant, ParticipantCount, PeerType, Pin, TrackInfo, TrackType, TrackUnpublishReason, WebsocketReconnectStrategy } from '../models/models';
+import { CallEndedReason } from '../models/models';
+import { GoAwayReason } from '../models/models';
+import { CallGrants } from '../models/models';
+import { Codec } from '../models/models';
+import { ConnectionQuality } from '../models/models';
+import { PublishOptions } from '../models/models';
+import { CallState } from '../models/models';
 import { TrackSubscriptionDetails } from '../signal_rpc/signal';
+import { TrackInfo } from '../models/models';
+import { ClientDetails } from '../models/models';
+import { TrackUnpublishReason } from '../models/models';
+import { Participant } from '../models/models';
+import { TrackType } from '../models/models';
+import { ParticipantCount } from '../models/models';
+import { PeerType } from '../models/models';
+import { WebsocketReconnectStrategy } from '../models/models';
+import { Error as Error$ } from '../models/models';
+import { Pin } from '../models/models';
+import { PublishOption } from '../models/models';
+import { ICETrickle as ICETrickle$ } from '../models/models';
 /**
  * SFUEvent is a message that is sent from the SFU to the client.
  *
@@ -200,10 +218,41 @@ export interface SfuEvent {
          * @generated from protobuf field: stream.video.sfu.event.ParticipantMigrationComplete participant_migration_complete = 25;
          */
         participantMigrationComplete: ParticipantMigrationComplete;
+    } | {
+        oneofKind: 'codecNegotiationComplete';
+        /**
+         * CodecNegotiationComplete is sent to signal the completion of a codec negotiation.
+         * SDKs can safely stop previous transceivers
+         *
+         * @generated from protobuf field: stream.video.sfu.event.CodecNegotiationComplete codec_negotiation_complete = 26;
+         */
+        codecNegotiationComplete: CodecNegotiationComplete;
+    } | {
+        oneofKind: 'changePublishOptions';
+        /**
+         * ChangePublishOptions is sent to signal the change in publish options such as a new codec or simulcast layers
+         *
+         * @generated from protobuf field: stream.video.sfu.event.ChangePublishOptions change_publish_options = 27;
+         */
+        changePublishOptions: ChangePublishOptions;
     } | {
         oneofKind: undefined;
     };
 }
+/**
+ * @generated from protobuf message stream.video.sfu.event.ChangePublishOptions
+ */
+export interface ChangePublishOptions {
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.PublishOption publish_option = 1;
+     */
+    publishOption?: PublishOption;
+}
+/**
+ * @generated from protobuf message stream.video.sfu.event.CodecNegotiationComplete
+ */
+export interface CodecNegotiationComplete {
+}
 /**
  * @generated from protobuf message stream.video.sfu.event.ParticipantMigrationComplete
  */
@@ -392,6 +441,10 @@ export interface JoinRequest {
      * @generated from protobuf field: string subscriber_sdp = 3;
      */
     subscriberSdp: string;
+    /**
+     * @generated from protobuf field: string publisher_sdp = 8;
+     */
+    publisherSdp: string;
     /**
      * @generated from protobuf field: stream.video.sfu.models.ClientDetails client_details = 4;
      */
@@ -487,6 +540,10 @@ export interface JoinResponse {
      * @generated from protobuf field: int32 fast_reconnect_deadline_seconds = 3;
      */
     fastReconnectDeadlineSeconds: number;
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.PublishOptions publish_options = 4;
+     */
+    publishOptions?: PublishOptions;
 }
 /**
  * ParticipantJoined is fired when a user joins a call
@@ -770,6 +827,20 @@ declare class SfuEvent$Type extends MessageType<SfuEvent> {
  * @generated MessageType for protobuf message stream.video.sfu.event.SfuEvent
  */
 export declare const SfuEvent: SfuEvent$Type;
+declare class ChangePublishOptions$Type extends MessageType<ChangePublishOptions> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.event.ChangePublishOptions
+ */
+export declare const ChangePublishOptions: ChangePublishOptions$Type;
+declare class CodecNegotiationComplete$Type extends MessageType<CodecNegotiationComplete> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.event.CodecNegotiationComplete
+ */
+export declare const CodecNegotiationComplete: CodecNegotiationComplete$Type;
 declare class ParticipantMigrationComplete$Type extends MessageType<ParticipantMigrationComplete> {
     constructor();
 }

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

@@ -189,34 +189,68 @@ export interface VideoLayer {
      */
     quality: VideoQuality;
 }
+/**
+ * @generated from protobuf message stream.video.sfu.models.PublishOptions
+ */
+export interface PublishOptions {
+    /**
+     * @generated from protobuf field: repeated stream.video.sfu.models.PublishOption codecs = 1;
+     */
+    codecs: PublishOption[];
+}
+/**
+ * @generated from protobuf message stream.video.sfu.models.PublishOption
+ */
+export interface PublishOption {
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.TrackType track_type = 1;
+     */
+    trackType: TrackType;
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.Codec codec = 2;
+     */
+    codec?: Codec;
+    /**
+     * @generated from protobuf field: int32 bitrate = 3;
+     */
+    bitrate: number;
+    /**
+     * @generated from protobuf field: int32 fps = 4;
+     */
+    fps: number;
+    /**
+     * @generated from protobuf field: int32 max_spatial_layers = 5;
+     */
+    maxSpatialLayers: number;
+    /**
+     * @generated from protobuf field: int32 max_temporal_layers = 6;
+     */
+    maxTemporalLayers: number;
+}
 /**
  * @generated from protobuf message stream.video.sfu.models.Codec
  */
 export interface Codec {
     /**
-     * @generated from protobuf field: uint32 payload_type = 1;
+     * @generated from protobuf field: uint32 payload_type = 11;
      */
     payloadType: number;
     /**
-     * @generated from protobuf field: string name = 2;
+     * @generated from protobuf field: string name = 10;
      */
     name: string;
     /**
-     * @generated from protobuf field: string fmtp_line = 3;
-     */
-    fmtpLine: string;
-    /**
-     * @generated from protobuf field: uint32 clock_rate = 4;
+     * @generated from protobuf field: uint32 clock_rate = 14;
      */
     clockRate: number;
     /**
-     * @generated from protobuf field: string encoding_parameters = 5;
+     * @generated from protobuf field: string encoding_parameters = 13;
      */
     encodingParameters: string;
     /**
-     * @generated from protobuf field: repeated string feedbacks = 6;
+     * @generated from protobuf field: string fmtp = 12;
      */
-    feedbacks: string[];
+    fmtp: string;
 }
 /**
  * @generated from protobuf message stream.video.sfu.models.ICETrickle
@@ -930,6 +964,20 @@ declare class VideoLayer$Type extends MessageType<VideoLayer> {
  * @generated MessageType for protobuf message stream.video.sfu.models.VideoLayer
  */
 export declare const VideoLayer: VideoLayer$Type;
+declare class PublishOptions$Type extends MessageType<PublishOptions> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.PublishOptions
+ */
+export declare const PublishOptions: PublishOptions$Type;
+declare class PublishOption$Type extends MessageType<PublishOption> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.models.PublishOption
+ */
+export declare const PublishOption: PublishOption$Type;
 declare class Codec$Type extends MessageType<Codec> {
     constructor();
 }

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

@@ -1,6 +1,25 @@
-import type { RpcOptions, RpcTransport, ServiceInfo, UnaryCall } from '@protobuf-ts/runtime-rpc';
-import type { ICERestartRequest, ICERestartResponse, ICETrickleResponse, SendAnswerRequest, SendAnswerResponse, SendStatsRequest, SendStatsResponse, SetPublisherRequest, SetPublisherResponse, StartNoiseCancellationRequest, StartNoiseCancellationResponse, StopNoiseCancellationRequest, StopNoiseCancellationResponse, UpdateMuteStatesRequest, UpdateMuteStatesResponse, UpdateSubscriptionsRequest, UpdateSubscriptionsResponse } from './signal';
+import type { RpcTransport } from '@protobuf-ts/runtime-rpc';
+import type { ServiceInfo } from '@protobuf-ts/runtime-rpc';
+import type { StopNoiseCancellationResponse } from './signal';
+import type { StopNoiseCancellationRequest } from './signal';
+import type { StartNoiseCancellationResponse } from './signal';
+import type { StartNoiseCancellationRequest } from './signal';
+import type { SendStatsResponse } from './signal';
+import type { SendStatsRequest } from './signal';
+import type { ICERestartResponse } from './signal';
+import type { ICERestartRequest } from './signal';
+import type { UpdateMuteStatesResponse } from './signal';
+import type { UpdateMuteStatesRequest } from './signal';
+import type { UpdateSubscriptionsResponse } from './signal';
+import type { UpdateSubscriptionsRequest } from './signal';
+import type { ICETrickleResponse } from './signal';
 import type { ICETrickle } from '../models/models';
+import type { SendAnswerResponse } from './signal';
+import type { SendAnswerRequest } from './signal';
+import type { SetPublisherResponse } from './signal';
+import type { SetPublisherRequest } from './signal';
+import type { UnaryCall } from '@protobuf-ts/runtime-rpc';
+import type { RpcOptions } from '@protobuf-ts/runtime-rpc';
 /**
  * @generated from protobuf service stream.video.sfu.signal.SignalServer
  */

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

@@ -1,6 +1,14 @@
-import { AndroidState, AppleState, Error, InputDevices, PeerType, TrackInfo, TrackType, VideoDimension } from '../models/models';
 import { ServiceType } from '@protobuf-ts/runtime-rpc';
 import { MessageType } from '@protobuf-ts/runtime';
+import { TrackInfo } from '../models/models';
+import { VideoDimension } from '../models/models';
+import { TrackType } from '../models/models';
+import { PeerType } from '../models/models';
+import { AppleState } from '../models/models';
+import { AndroidState } from '../models/models';
+import { InputDevices } from '../models/models';
+import { WebsocketReconnectStrategy } from '../models/models';
+import { Error } from '../models/models';
 /**
  * @generated from protobuf message stream.video.sfu.signal.StartNoiseCancellationRequest
  */
@@ -37,6 +45,42 @@ export interface StopNoiseCancellationResponse {
      */
     error?: Error;
 }
+/**
+ * @generated from protobuf message stream.video.sfu.signal.Reconnection
+ */
+export interface Reconnection {
+    /**
+     * @generated from protobuf field: float time_seconds = 1;
+     */
+    timeSeconds: number;
+    /**
+     * @generated from protobuf field: stream.video.sfu.models.WebsocketReconnectStrategy strategy = 2;
+     */
+    strategy: WebsocketReconnectStrategy;
+}
+/**
+ * @generated from protobuf message stream.video.sfu.signal.Telemetry
+ */
+export interface Telemetry {
+    /**
+     * @generated from protobuf oneof: data
+     */
+    data: {
+        oneofKind: 'connectionTimeSeconds';
+        /**
+         * @generated from protobuf field: float connection_time_seconds = 1;
+         */
+        connectionTimeSeconds: number;
+    } | {
+        oneofKind: 'reconnection';
+        /**
+         * @generated from protobuf field: stream.video.sfu.signal.Reconnection reconnection = 2;
+         */
+        reconnection: Reconnection;
+    } | {
+        oneofKind: undefined;
+    };
+}
 /**
  * @generated from protobuf message stream.video.sfu.signal.SendStatsRequest
  */
@@ -91,6 +135,10 @@ export interface SendStatsRequest {
     } | {
         oneofKind: undefined;
     };
+    /**
+     * @generated from protobuf field: stream.video.sfu.signal.Telemetry telemetry = 11;
+     */
+    telemetry?: Telemetry;
 }
 /**
  * @generated from protobuf message stream.video.sfu.signal.SendStatsResponse
@@ -324,6 +372,20 @@ declare class StopNoiseCancellationResponse$Type extends MessageType<StopNoiseCa
  * @generated MessageType for protobuf message stream.video.sfu.signal.StopNoiseCancellationResponse
  */
 export declare const StopNoiseCancellationResponse: StopNoiseCancellationResponse$Type;
+declare class Reconnection$Type extends MessageType<Reconnection> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.Reconnection
+ */
+export declare const Reconnection: Reconnection$Type;
+declare class Telemetry$Type extends MessageType<Telemetry> {
+    constructor();
+}
+/**
+ * @generated MessageType for protobuf message stream.video.sfu.signal.Telemetry
+ */
+export declare const Telemetry: Telemetry$Type;
 declare class SendStatsRequest$Type extends MessageType<SendStatsRequest> {
     constructor();
 }

package/dist/src/stats/SfuStatsReporter.d.ts

@@ -4,6 +4,7 @@ import { Publisher, Subscriber } from '../rtc';
 import { LocalClientDetailsType } from '../client-details';
 import { CameraManager, MicrophoneManager } from '../devices';
 import { CallState } from '../store';
+import { Telemetry } from '../gen/video/sfu/signal_rpc/signal';
 export type SfuStatsReporterOptions = {
     options: StatsOptions;
     clientDetails: LocalClientDetailsType;
@@ -31,6 +32,7 @@ export declare class SfuStatsReporter {
     private readonly inputDevices;
     constructor(sfuClient: StreamSfuClient, { options, clientDetails, subscriber, publisher, microphone, camera, state, }: SfuStatsReporterOptions);
     private observeDevice;
+    sendTelemetryData: (telemetryData: Telemetry) => Promise<void>;
     private run;
     start: () => void;
     stop: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.10.5",
+  "version": "1.11.0",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/Call.ts

@@ -725,6 +725,7 @@ export class Call {
    * @returns a promise which resolves once the call join-flow has finished.
    */
   join = async (data?: JoinCallData): Promise<void> => {
+    const connectStartTime = Date.now();
     await this.setup();
     const callingState = this.state.callingState;
     if ([CallingState.JOINED, CallingState.JOINING].includes(callingState)) {
@@ -793,11 +794,11 @@ export class Call {
           : undefined;
       const { callState, fastReconnectDeadlineSeconds } = await sfuClient.join({
         subscriberSdp: receivingCapabilitiesSdp,
+        publisherSdp: '',
         clientDetails,
         fastReconnect: performingFastReconnect,
         reconnectDetails,
       });
-
       this.fastReconnectDeadlineSeconds = fastReconnectDeadlineSeconds;
       if (callState) {
         this.state.updateFromSfuCallState(
@@ -831,6 +832,16 @@ export class Call {
       });
     }
 
+    // make sure we only track connection timing if we are not calling this method as part of a reconnection flow
+    if (!performingRejoin && !performingFastReconnect && !performingMigration) {
+      this.sfuStatsReporter?.sendTelemetryData({
+        data: {
+          oneofKind: 'connectionTimeSeconds',
+          connectionTimeSeconds: (Date.now() - connectStartTime) / 1000,
+        },
+      });
+    }
+
     if (performingRejoin) {
       const strategy = WebsocketReconnectStrategy[this.reconnectStrategy];
       await previousSfuClient?.leaveAndClose(
@@ -1130,9 +1141,19 @@ export class Call {
    * @internal
    */
   private reconnectFast = async () => {
+    let reconnectStartTime = Date.now();
     this.reconnectStrategy = WebsocketReconnectStrategy.FAST;
     this.state.setCallingState(CallingState.RECONNECTING);
-    return this.join(this.joinCallData);
+    await this.join(this.joinCallData);
+    this.sfuStatsReporter?.sendTelemetryData({
+      data: {
+        oneofKind: 'reconnection',
+        reconnection: {
+          timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+          strategy: WebsocketReconnectStrategy.FAST,
+        },
+      },
+    });
   };
 
   /**
@@ -1140,11 +1161,21 @@ export class Call {
    * @internal
    */
   private reconnectRejoin = async () => {
+    let reconnectStartTime = Date.now();
     this.reconnectStrategy = WebsocketReconnectStrategy.REJOIN;
     this.state.setCallingState(CallingState.RECONNECTING);
     await this.join(this.joinCallData);
     await this.restorePublishedTracks();
     this.restoreSubscribedTracks();
+    this.sfuStatsReporter?.sendTelemetryData({
+      data: {
+        oneofKind: 'reconnection',
+        reconnection: {
+          timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+          strategy: WebsocketReconnectStrategy.REJOIN,
+        },
+      },
+    });
   };
 
   /**
@@ -1152,6 +1183,7 @@ export class Call {
    * @internal
    */
   private reconnectMigrate = async () => {
+    let reconnectStartTime = Date.now();
     const currentSfuClient = this.sfuClient;
     if (!currentSfuClient) {
       throw new Error('Cannot migrate without an active SFU client');
@@ -1196,6 +1228,15 @@ export class Call {
       // and close the previous SFU client, without specifying close code
       currentSfuClient.close();
     }
+    this.sfuStatsReporter?.sendTelemetryData({
+      data: {
+        oneofKind: 'reconnection',
+        reconnection: {
+          timeSeconds: (Date.now() - reconnectStartTime) / 1000,
+          strategy: WebsocketReconnectStrategy.MIGRATE,
+        },
+      },
+    });
   };
 
   /**

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

@@ -33,18 +33,13 @@
 // (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 type {
-  JsonObject,
-  JsonReadOptions,
-  JsonValue,
-  JsonWriteOptions,
-} from '@protobuf-ts/runtime';
-import {
-  isJsonObject,
-  MessageType,
-  typeofJsonValue,
-} from '@protobuf-ts/runtime';
-
+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';
 /**
  * `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

@@ -33,13 +33,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 type {
-  JsonReadOptions,
-  JsonValue,
-  JsonWriteOptions,
-} from '@protobuf-ts/runtime';
-import { MessageType, PbLong, typeofJsonValue } 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 { PbLong } from '@protobuf-ts/runtime';
+import { MessageType } 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