@signalapp/ringrtc 2.70.2 → 2.72.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { RingRTCType } from './ringrtc/Service';
-export type { AudioDevice, CallId, CallSettings, DeviceId, GroupCallObserver, HttpResult, PeekDeviceInfo, PeekInfo, Reaction, UserId, VideoFrameSender, VideoFrameSource, } from './ringrtc/Service';
+export type { AudioDevice, CallId, CallSettings, DeviceId, GroupCallObserver, GroupCallSvcConfig, HttpResult, PeekDeviceInfo, PeekInfo, Reaction, UserId, VideoFrameSender, VideoFrameSource, } from './ringrtc/Service';
 export { AnswerMessage, DataMode, BusyMessage, Call, CallEndReason, CallLogLevel, CallMessageUrgency, CallRejectReason, CallState, CallingMessage, ConnectionState, GroupCall, GroupCallKind, GroupMemberInfo, HangupMessage, HangupType, HttpMethod, IceCandidateMessage, JoinState, LocalDeviceState, OfferMessage, OfferType, OpaqueMessage, PeekStatusCodes, RemoteDeviceState, RingCancelReason, RingRTCType, RingUpdate, SpeechEvent, VideoPixelFormatEnum, videoPixelFormatToEnum, VideoRequest, callIdFromEra, callIdFromRingId, } from './ringrtc/Service';
 export { CallLinkRootKey, CallLinkRestrictions, CallLinkState, } from './ringrtc/CallLinks';
 export { CallSummary, QualityStats } from './ringrtc/CallSummary';

package/dist/ringrtc/CallLinks.d.ts

@@ -6,6 +6,7 @@ export declare class CallLinkRootKey {
     static generate(): CallLinkRootKey;
     static generateAdminPassKey(): Uint8Array<ArrayBuffer>;
     deriveRoomId(): Uint8Array<ArrayBuffer>;
+    toUnredactedString(): string;
     toString(): string;
 }
 export declare class CallLinkState {

package/dist/ringrtc/CallLinks.js

@@ -31,10 +31,14 @@ class CallLinkRootKey {
         // oxlint-disable-next-line typescript/no-unsafe-return
         return Native_1.default.CallLinkRootKey_deriveRoomId(this.bytes);
     }
-    toString() {
+    toUnredactedString() {
         // oxlint-disable-next-line typescript/no-unsafe-return
         return Native_1.default.CallLinkRootKey_toFormattedString(this.bytes);
     }
+    toString() {
+        // oxlint-disable-next-line typescript/no-unsafe-return
+        return Native_1.default.CallLinkRootKey_toRedactedString(this.bytes);
+    }
 }
 exports.CallLinkRootKey = CallLinkRootKey;
 class CallLinkState {

package/dist/ringrtc/Service.d.ts

@@ -238,8 +238,8 @@ export declare class RingRTCType {
     deleteCallLink(sfuUrl: string, authCredentialPresentation: Uint8Array<ArrayBuffer>, linkRootKey: CallLinkRootKey, adminPasskey: Uint8Array<ArrayBuffer>): Promise<HttpResult<undefined>>;
     receivedHttpResponse(requestId: number, status: number, body: Uint8Array<ArrayBuffer>): void;
     httpRequestFailed(requestId: number, debugInfo: string | undefined): void;
-    getGroupCall(groupId: GroupId, sfuUrl: string, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number | undefined, dredDuration: number | undefined, observer: GroupCallObserver): GroupCall | undefined;
-    getCallLinkCall(sfuUrl: string, endorsementPublicKey: Uint8Array<ArrayBuffer>, authCredentialPresentation: Uint8Array<ArrayBuffer>, rootKey: CallLinkRootKey, adminPasskey: Uint8Array<ArrayBuffer> | undefined, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number | undefined, dredDuration: number | undefined, observer: GroupCallObserver): GroupCall | undefined;
+    getGroupCall(groupId: GroupId, sfuUrl: string, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number | undefined, dredDuration: number | undefined, svcConfig: GroupCallSvcConfig | undefined, observer: GroupCallObserver): GroupCall | undefined;
+    getCallLinkCall(sfuUrl: string, endorsementPublicKey: Uint8Array<ArrayBuffer>, authCredentialPresentation: Uint8Array<ArrayBuffer>, rootKey: CallLinkRootKey, adminPasskey: Uint8Array<ArrayBuffer> | undefined, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number | undefined, dredDuration: number | undefined, svcConfig: GroupCallSvcConfig | undefined, observer: GroupCallObserver): GroupCall | undefined;
     peekGroupCall(sfuUrl: string, membershipProof: Uint8Array<ArrayBuffer>, groupMembers: Array<GroupMemberInfo>): Promise<PeekInfo>;
     setMicrophoneWarmupEnabled(warmup: boolean): void;
     peekCallLinkCall(sfuUrl: string, authCredentialPresentation: Uint8Array<ArrayBuffer>, rootKey: CallLinkRootKey): Promise<HttpResult<PeekInfo>>;
@@ -311,12 +311,22 @@ export declare class RingRTCType {
      */
     setVoiceProcessingEnabled(enabled: boolean): void;
 }
+type CallConfig = {
+    dataMode: DataMode;
+    dredDuration: number;
+    enableVp9Encode: boolean;
+    enableVp9Decode: boolean;
+    statsIntervalSecs?: number;
+};
 export type CallSettings = {
     iceServers: Array<IceServer>;
     hideIp: boolean;
     dataMode: DataMode;
     audioLevelsIntervalMillis?: number;
     dredDuration?: number;
+    enableVp9Encode?: boolean;
+    enableVp9Decode?: boolean;
+    statsIntervalSecs?: number;
 };
 type IceServer = {
     username?: string;
@@ -529,6 +539,11 @@ export type GroupCallObserver = {
     onRemoteMute(groupCall: GroupCall, demuxId: number): void;
     onObservedRemoteMute(groupCall: GroupCall, sourceDemuxId: number, targetDemuxId: number): void;
 };
+export type GroupCallSvcConfig = {
+    mode: string;
+    modeForScreenshare: string;
+    maxBitrateBps: number | undefined;
+};
 export declare class GroupCall {
     private readonly _kind;
     private readonly _callManager;
@@ -658,7 +673,7 @@ export type CallManager = {
     setSelfUuid(uuid: Uint8Array<ArrayBuffer>): void;
     addAsset(assetGroup: string, filePath: string | null, content: Uint8Array<ArrayBuffer> | null): void;
     createOutgoingCall(remoteUserId: UserId, isVideoCall: boolean, localDeviceId: DeviceId): CallId;
-    proceed(callId: CallId, iceServers: Array<IceServer>, hideIp: boolean, dataMode: DataMode, audioLevelsIntervalMillis: number, dredDuration: number): void;
+    proceed(callId: CallId, iceServers: Array<IceServer>, hideIp: boolean, callConfig: CallConfig, audioLevelsIntervalMillis: number): void;
     accept(callId: CallId): void;
     ignore(callId: CallId): void;
     hangup(): void;
@@ -680,8 +695,8 @@ export type CallManager = {
     receivedCallMessage(remoteUserId: Uint8Array<ArrayBuffer>, remoteDeviceId: DeviceId, localDeviceId: DeviceId, data: Uint8Array<ArrayBuffer>, messageAgeSec: number): void;
     receivedHttpResponse(requestId: number, status: number, body: Uint8Array<ArrayBuffer>): void;
     httpRequestFailed(requestId: number, debugInfo: string | undefined): void;
-    createGroupCallClient(groupId: GroupId, sfuUrl: string, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number, dredDuration: number): GroupCallClientId;
-    createCallLinkCallClient(sfuUrl: string, endorsementPublicKey: Uint8Array<ArrayBuffer>, authCredentialPresentation: Uint8Array<ArrayBuffer>, linkRootKey: Uint8Array<ArrayBuffer>, adminPasskey: Uint8Array<ArrayBuffer> | undefined, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number, dredDuration: number): GroupCallClientId;
+    createGroupCallClient(groupId: GroupId, sfuUrl: string, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number, dredDuration: number, svcConfig: GroupCallSvcConfig | undefined): GroupCallClientId;
+    createCallLinkCallClient(sfuUrl: string, endorsementPublicKey: Uint8Array<ArrayBuffer>, authCredentialPresentation: Uint8Array<ArrayBuffer>, linkRootKey: Uint8Array<ArrayBuffer>, adminPasskey: Uint8Array<ArrayBuffer> | undefined, hkdfExtraInfo: Uint8Array<ArrayBuffer>, audioLevelsIntervalMillis: number, dredDuration: number, svcConfig: GroupCallSvcConfig | undefined): GroupCallClientId;
     deleteGroupCallClient(clientId: GroupCallClientId): void;
     connect(clientId: GroupCallClientId): void;
     join(clientId: GroupCallClientId): void;

package/dist/ringrtc/Service.js

@@ -390,7 +390,13 @@ class RingRTCType {
     }
     proceed(callId, settings) {
         sillyDeadlockProtection(() => {
-            this.callManager.proceed(callId, settings.iceServers, settings.hideIp, settings.dataMode, settings.audioLevelsIntervalMillis || 0, settings.dredDuration ?? 0);
+            this.callManager.proceed(callId, settings.iceServers, settings.hideIp, {
+                dataMode: settings.dataMode,
+                dredDuration: settings.dredDuration ?? 0,
+                enableVp9Encode: settings.enableVp9Encode ?? true,
+                enableVp9Decode: settings.enableVp9Decode ?? true,
+                statsIntervalSecs: settings.statsIntervalSecs,
+            }, settings.audioLevelsIntervalMillis || 0);
         });
     }
     // Called by Rust
@@ -724,8 +730,8 @@ class RingRTCType {
     }
     // Group Calls
     // Called by UX
-    getGroupCall(groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis, dredDuration, observer) {
-        const clientId = this.callManager.createGroupCallClient(groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis ?? 0, dredDuration ?? 0);
+    getGroupCall(groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis, dredDuration, svcConfig, observer) {
+        const clientId = this.callManager.createGroupCallClient(groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis ?? 0, dredDuration ?? 0, svcConfig);
         if (clientId === INVALID_CLIENT_ID) {
             // Return undefined since the group call client creation failed.
             return undefined;
@@ -735,8 +741,8 @@ class RingRTCType {
         return groupCall;
     }
     // Called by UX
-    getCallLinkCall(sfuUrl, endorsementPublicKey, authCredentialPresentation, rootKey, adminPasskey, hkdfExtraInfo, audioLevelsIntervalMillis, dredDuration, observer) {
-        const clientId = this.callManager.createCallLinkCallClient(sfuUrl, endorsementPublicKey, authCredentialPresentation, rootKey.bytes, adminPasskey, hkdfExtraInfo, audioLevelsIntervalMillis || 0, dredDuration ?? 0);
+    getCallLinkCall(sfuUrl, endorsementPublicKey, authCredentialPresentation, rootKey, adminPasskey, hkdfExtraInfo, audioLevelsIntervalMillis, dredDuration, svcConfig, observer) {
+        const clientId = this.callManager.createCallLinkCallClient(sfuUrl, endorsementPublicKey, authCredentialPresentation, rootKey.bytes, adminPasskey, hkdfExtraInfo, audioLevelsIntervalMillis || 0, dredDuration ?? 0, svcConfig);
         if (clientId === INVALID_CLIENT_ID) {
             // Return undefined since the call link client creation failed.
             return undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/ringrtc",
-  "version": "2.70.2",
+  "version": "2.72.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/signalapp/ringrtc.git",
@@ -33,13 +33,13 @@
   },
   "config": {
     "prebuildUrl": "https://build-artifacts.signal.org/libraries/ringrtc-desktop-build-v${npm_package_version}.tar.gz",
-    "prebuildChecksum": "5833836ccafc7eb27fae603bf80c33e8d7d4b70e7a9c63d1b44988c5b1f78cf0"
+    "prebuildChecksum": "5030c683f0f181b0f132e58881c0d5e371f68185141de0e50c865d851b8b01de"
   },
   "author": "",
   "license": "AGPL-3.0-only",
   "dependencies": {
     "https-proxy-agent": "7.0.6",
-    "tar": "7.5.15"
+    "tar": "7.5.22"
   },
   "devDependencies": {
     "@types/chai": "5.2.3",