@4players/odin-common 2.4.13 → 2.6.0

package/lib/cjs/plugin/api.js

@@ -1,4 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinDBFS = void 0;
+exports.Backend = exports.MinDBFS = void 0;
 exports.MinDBFS = -758.596;
+var Backend;
+(function (Backend) {
+    let PeerCipherStatus;
+    (function (PeerCipherStatus) {
+        PeerCipherStatus[PeerCipherStatus["InvalidPassword"] = -1] = "InvalidPassword";
+        PeerCipherStatus[PeerCipherStatus["Unknown"] = 0] = "Unknown";
+        PeerCipherStatus[PeerCipherStatus["Unecrypted"] = 1] = "Unecrypted";
+        PeerCipherStatus[PeerCipherStatus["Encrypted"] = 2] = "Encrypted";
+    })(PeerCipherStatus = Backend.PeerCipherStatus || (Backend.PeerCipherStatus = {}));
+})(Backend || (exports.Backend = Backend = {}));

package/lib/esm/plugin/api.js

@@ -1 +1,11 @@
 export const MinDBFS = -758.596;
+export var Backend;
+(function (Backend) {
+    let PeerCipherStatus;
+    (function (PeerCipherStatus) {
+        PeerCipherStatus[PeerCipherStatus["InvalidPassword"] = -1] = "InvalidPassword";
+        PeerCipherStatus[PeerCipherStatus["Unknown"] = 0] = "Unknown";
+        PeerCipherStatus[PeerCipherStatus["Unecrypted"] = 1] = "Unecrypted";
+        PeerCipherStatus[PeerCipherStatus["Encrypted"] = 2] = "Encrypted";
+    })(PeerCipherStatus = Backend.PeerCipherStatus || (Backend.PeerCipherStatus = {}));
+})(Backend || (Backend = {}));

package/lib/plugin/api.d.ts

@@ -3,7 +3,7 @@ export declare namespace Backend {
     type UID = string;
     type OnStatusChanged = (status: 'started' | 'stopped') => void;
     type OnEvent = (method: string, properties: unknown) => void;
-    type Version = '1';
+    type Version = '2';
     interface Plugin {
         readonly version: Version;
         readonly playbackVolume: Volume;
@@ -36,15 +36,18 @@ export declare namespace Backend {
         readonly roomId?: string;
         readonly userData?: Uint8Array;
         readonly position?: [number, number, number];
-        readonly cipher?: Cipher;
+        readonly cipher?: SetupCipherSettings;
         readonly onEvent: OnEvent;
     }
     interface Room {
         readonly token: string;
+        readonly cipher: Cipher | undefined;
         request(method: string, properties: unknown): Promise<unknown>;
         link(media: Media): Promise<void>;
         unlink(media: Media): void;
         close(): void;
+        configureCipher(settings: CipherSettings): void;
+        getPeerCipherStatus(peerId: number): PeerCipherStatus;
     }
     interface Media {
         readonly customType?: string;
@@ -53,7 +56,7 @@ export declare namespace Backend {
     interface AudioMedia extends Media {
         readonly volume: Volume;
         readonly activity: Activity;
-        setVolume(value: Volume): void;
+        setVolume(value: Volume): Promise<void>;
     }
     interface CreateAudioPlaybackParameters {
         readonly uid: UID;
@@ -76,8 +79,8 @@ export declare namespace Backend {
         readonly vad?: VadConfig;
         readonly apm?: ApmConfig;
         setVad(config: VadConfig): void;
-        setApm(config: ApmConfig): void;
-        setDevice(device: DeviceParameters): void;
+        setApm(config: ApmConfig): Promise<void>;
+        setDevice(device: DeviceParameters): Promise<void>;
     }
     interface VideoCapture extends Media {
         mediaStream?: MediaStream;
@@ -105,8 +108,21 @@ export declare namespace Backend {
         transientSuppressor: boolean;
         gainController: boolean;
     }
-    type Cipher = {
+    type SetupCipherSettings = {
         type: 'OdinCrypto';
-        password: string;
-    };
+    } & OdinCryptoSettings;
+    type CipherSettings = OdinCryptoSettings;
+    interface OdinCryptoSettings {
+        password: string | null;
+    }
+    enum PeerCipherStatus {
+        InvalidPassword = -1,
+        Unknown = 0,
+        Unecrypted = 1,
+        Encrypted = 2
+    }
+    interface Cipher {
+        configure(settings: CipherSettings): void;
+        getPeerStatus(peerId: number): PeerCipherStatus;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "2.4.13",
+  "version": "2.6.0",
   "description": "A collection of commonly used type definitions and utility functions across ODIN web projects",
   "author": "Josho Bleicker <josho.bleicker@4players.io> (https://www.4players.io)",
   "homepage": "https://www.4players.io",