@4players/odin-common 1.0.6

package/lib/types/plugins/api.d.ts

@@ -0,0 +1,88 @@
+export declare namespace Backend {
+    type UID = string;
+    type OnStatusChanged = (status: 'started' | 'stopped') => void;
+    type OnEvent = (method: string, properties: unknown) => void;
+    interface Plugin {
+        readonly version: '1';
+        readonly playbackVolume: Volume;
+        joinRoom(parameters: JoinRoomParameters): Room;
+        createAudioPlayback(parameters: CreateAudioPlaybackParameters): Promise<AudioPlayback>;
+        createAudioCapture(parameters: CreateAudioCaptureParameters): Promise<AudioCapture>;
+        enumerateDevices(): Promise<Array<Device>>;
+        setOutputVolume(volume: Volume): void;
+        setOutputDevice(device: DeviceParameters): void;
+        close(): void;
+    }
+    interface Device {
+        readonly type: 'AudioPlayback' | 'AudioCapture';
+        readonly name: string;
+        readonly isDefault: boolean;
+    }
+    interface DeviceParameters {
+        readonly device?: Device;
+        onStatusChanged?: OnStatusChanged;
+    }
+    interface Activity {
+        isSilent: boolean;
+        rmsDBFS: number;
+    }
+    interface JoinRoomParameters {
+        readonly gateway: string | undefined;
+        readonly token: string;
+        readonly roomId?: string;
+        readonly userData?: Uint8Array;
+        readonly position?: [number, number, number];
+        readonly onEvent: OnEvent;
+    }
+    interface Room {
+        request(method: string, properties: unknown): Promise<unknown>;
+        link(media: Media): void;
+        unlink(media: Media): void;
+        close(): void;
+    }
+    interface Media {
+        close(): void;
+    }
+    interface AudioMedia extends Media {
+        readonly volume: Volume;
+        readonly activity: Activity;
+        setVolume(value: Volume): void;
+    }
+    interface CreateAudioPlaybackParameters {
+        readonly uid: UID;
+        readonly volume?: Volume;
+    }
+    interface AudioPlayback extends AudioMedia {
+        readonly uid: UID;
+    }
+    interface CreateAudioCaptureParameters extends Partial<DeviceParameters> {
+        readonly volume?: Volume;
+        readonly vad?: VadConfig;
+        readonly apm?: ApmConfig;
+    }
+    interface AudioCapture extends AudioMedia {
+        readonly vad?: VadConfig;
+        readonly apm?: ApmConfig;
+        setVad(config: VadConfig): void;
+        setApm(config: ApmConfig): void;
+        setDevice(device: DeviceParameters): void;
+    }
+    type Volume = number | 'muted';
+    interface VadConfig {
+        voiceActivity?: SensitivityRange;
+        volumeGate?: SensitivityRange;
+    }
+    interface SensitivityRange {
+        attackThreshold: number;
+        releaseThreshold: number;
+    }
+    interface ApmConfig {
+        echoCanceller: boolean;
+        highPassFilter: boolean;
+        preAmplifier: boolean;
+        captureLevelAdjustment: boolean;
+        noiseSuppression: 'None' | 'Low' | 'Moderate' | 'High' | 'VeryHigh';
+        transientSuppressor: boolean;
+        gainController: boolean;
+    }
+}

package/lib/types/schemas/media.d.ts

@@ -0,0 +1,114 @@
+import * as z from 'zod';
+export declare const MediaIdSchema: z.ZodNumber;
+export type MediaId = z.infer<typeof MediaIdSchema>;
+export declare const MediaAudioPropertiesSchema: z.ZodObject<{
+    kind: z.ZodOptional<z.ZodLiteral<"audio">>;
+    uid: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind?: "audio" | undefined;
+    uid?: string | undefined;
+}, {
+    kind?: "audio" | undefined;
+    uid?: string | undefined;
+}>;
+export type MediaAudioProperties = z.infer<typeof MediaAudioPropertiesSchema>;
+export declare const MediaVideoPropertiesSchema: z.ZodObject<{
+    kind: z.ZodOptional<z.ZodLiteral<"video">>;
+    codec: z.ZodOptional<z.ZodString>;
+    uid: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind?: "video" | undefined;
+    codec?: string | undefined;
+    uid?: string | undefined;
+}, {
+    kind?: "video" | undefined;
+    codec?: string | undefined;
+    uid?: string | undefined;
+}>;
+export type MediaVideoProperties = z.infer<typeof MediaVideoPropertiesSchema>;
+export declare const MediaPropertiesSchema: z.ZodUnion<[z.ZodObject<{
+    kind: z.ZodOptional<z.ZodLiteral<"audio">>;
+    uid: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind?: "audio" | undefined;
+    uid?: string | undefined;
+}, {
+    kind?: "audio" | undefined;
+    uid?: string | undefined;
+}>, z.ZodObject<{
+    kind: z.ZodOptional<z.ZodLiteral<"video">>;
+    codec: z.ZodOptional<z.ZodString>;
+    uid: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    kind?: "video" | undefined;
+    codec?: string | undefined;
+    uid?: string | undefined;
+}, {
+    kind?: "video" | undefined;
+    codec?: string | undefined;
+    uid?: string | undefined;
+}>]>;
+export type MediaProperties = z.infer<typeof MediaPropertiesSchema>;
+export declare const MediaSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    properties: z.ZodUnion<[z.ZodObject<{
+        kind: z.ZodOptional<z.ZodLiteral<"audio">>;
+        uid: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    }, {
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    }>, z.ZodObject<{
+        kind: z.ZodOptional<z.ZodLiteral<"video">>;
+        codec: z.ZodOptional<z.ZodString>;
+        uid: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    }, {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    }>]>;
+    paused: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    properties: ({
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    } | {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    }) & ({
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    } | {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    } | undefined);
+    paused: boolean;
+}, {
+    id: number;
+    properties: ({
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    } | {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    }) & ({
+        kind?: "audio" | undefined;
+        uid?: string | undefined;
+    } | {
+        kind?: "video" | undefined;
+        codec?: string | undefined;
+        uid?: string | undefined;
+    } | undefined);
+    paused: boolean;
+}>;
+export type Media = z.infer<typeof MediaSchema>;

package/lib/types/schemas/message.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const MessageReceivedSchema: z.ZodObject<{
+    sender_peer_id: z.ZodNumber;
+    message: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+}, "strip", z.ZodTypeAny, {
+    message: Uint8Array;
+    sender_peer_id: number;
+}, {
+    message: Uint8Array;
+    sender_peer_id: number;
+}>;
+export type MessageReceived = z.infer<typeof MessageReceivedSchema>;

package/lib/types/schemas/peer.d.ts

@@ -0,0 +1,254 @@
+import * as z from 'zod';
+export declare const PeerIdSchema: z.ZodNumber;
+export type PeerId = z.infer<typeof PeerIdSchema>;
+export declare const PeerPositionSchema: z.ZodUnion<[z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber], null>, z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>]>;
+export type PeerPosition = z.infer<typeof PeerPositionSchema>;
+export declare const PeerSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    user_id: z.ZodString;
+    user_data: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+    medias: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        properties: z.ZodUnion<[z.ZodObject<{
+            kind: z.ZodOptional<z.ZodLiteral<"audio">>;
+            uid: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        }, {
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        }>, z.ZodObject<{
+            kind: z.ZodOptional<z.ZodLiteral<"video">>;
+            codec: z.ZodOptional<z.ZodString>;
+            uid: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }, {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }>]>;
+        paused: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }, {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    user_id: string;
+    user_data: Uint8Array;
+    medias: {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }[];
+}, {
+    id: number;
+    user_id: string;
+    user_data: Uint8Array;
+    medias: {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }[];
+}>;
+export type Peer = z.infer<typeof PeerSchema>;
+export declare const PeerUpdateSchema: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+    kind: z.ZodLiteral<"UserDataChanged">;
+    peer_id: z.ZodNumber;
+    user_data: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+}, "strip", z.ZodTypeAny, {
+    kind: "UserDataChanged";
+    user_data: Uint8Array;
+    peer_id: number;
+}, {
+    kind: "UserDataChanged";
+    user_data: Uint8Array;
+    peer_id: number;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"MediaStarted">;
+    peer_id: z.ZodNumber;
+    media: z.ZodObject<{
+        id: z.ZodNumber;
+        properties: z.ZodUnion<[z.ZodObject<{
+            kind: z.ZodOptional<z.ZodLiteral<"audio">>;
+            uid: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        }, {
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        }>, z.ZodObject<{
+            kind: z.ZodOptional<z.ZodLiteral<"video">>;
+            codec: z.ZodOptional<z.ZodString>;
+            uid: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }, {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }>]>;
+        paused: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }, {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    kind: "MediaStarted";
+    peer_id: number;
+    media: {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    };
+}, {
+    kind: "MediaStarted";
+    peer_id: number;
+    media: {
+        id: number;
+        properties: ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        }) & ({
+            kind?: "audio" | undefined;
+            uid?: string | undefined;
+        } | {
+            kind?: "video" | undefined;
+            codec?: string | undefined;
+            uid?: string | undefined;
+        } | undefined);
+        paused: boolean;
+    };
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"MediaStopped">;
+    peer_id: z.ZodNumber;
+    media_id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    kind: "MediaStopped";
+    peer_id: number;
+    media_id: number;
+}, {
+    kind: "MediaStopped";
+    peer_id: number;
+    media_id: number;
+}>]>;
+export type PeerUpdate = z.infer<typeof PeerUpdateSchema>;