@4players/odin-plugin-web 1.0.0-alpha.22 → 1.0.0-alpha.24

package/lib/plugin/index.d.ts

@@ -1,64 +1,130 @@
-import { Backend } from '@4players/odin-common';
-import { AudioContextFactory, CreateAudioCaptureParameters, CreateAudioPlaybackParameters, Device } from './mediaController';
-import { ConnectionPool } from './connectionPool';
-import { MainConnection } from './mainConnection';
-import { AudioCapture } from './medias/audio-capture';
-import { VideoCapture } from './medias/video-capture';
-import { VideoPlayback } from './medias/video-playback';
-import { AudioPlayback } from './medias/audio-playback';
-import JoinRoomParameters = Backend.JoinRoomParameters;
-import Cipher = Backend.Cipher;
-export type { LogFilters } from '@4players/odin-common';
-export { logger } from './config';
-type Plugin = Backend.Plugin;
-export interface DeviceParameters {
-    readonly device?: Device;
-    onStatusChanged?: Backend.OnStatusChanged;
+import { Backend, LogRecord, Logger } from '@4players/odin-common';
+
+export interface DecoderSlot {
+	index: number;
+	connectionId: number;
+	mediaId: number;
+	volume?: number;
 }
-export declare class WebPlugin implements Plugin {
-    readonly version = "3";
-    readonly supportedTransports: Backend.Transport[];
-    private _NextRoomId;
-    private _PlaybackVolume;
-    private readonly _ConnectionPool;
-    private readonly _MediaController;
-    get playbackVolume(): Backend.Volume;
-    static create(audioContextFactory: AudioContextFactory): Promise<WebPlugin>;
-    private constructor();
-    joinRoom(parameters: JoinRoomParameters): Room;
-    createAudioPlayback(parameters: CreateAudioPlaybackParameters): Promise<AudioPlayback>;
-    createAudioCapture(parameters: CreateAudioCaptureParameters): Promise<AudioCapture>;
-    createVideoCapture(ms: MediaStream, customType?: string): Promise<VideoCapture>;
-    createVideoPlayback(parameters: Backend.CreateVideoPlaybackParameters): Promise<VideoPlayback>;
-    enumerateDevices(): Promise<Device[]>;
-    setOutputVolume(volume: Backend.Volume): void;
-    setOutputDevice(device: DeviceParameters): Promise<void>;
-    close(): void;
+declare namespace Common {
+	type CaptureWorkletMessages = {
+		init: {
+			workerPort: MessagePort;
+		};
+		close: void;
+		dump: {
+			result: MessagePort;
+		};
+	};
+	type PlaybackWorkletMessages = {
+		init: {
+			workerPort: MessagePort;
+		};
+		samples: {
+			id: number;
+			buffer: Float32Array;
+		};
+		close: void;
+		dump: {
+			result: MessagePort;
+		};
+	};
+	type WorkerMessages = {
+		captureInit: {
+			sampleRate: number;
+			workletPort: MessagePort;
+		};
+		captureSetMedias: {
+			connections: Array<{
+				id: number;
+				mediaIds: number[];
+			}>;
+		};
+		captureSetVad: VadConfig;
+		captureTick: {};
+		playbackInit: {
+			workletPort: MessagePort;
+		};
+		playbackUpdateMedias: {
+			added: Array<DecoderSlot>;
+			removed: Array<DecoderSlot>;
+		};
+		playbackReceivePacket: {
+			connectionId: number;
+			packet: Uint8Array;
+		};
+		playbackTick: {};
+		close: void;
+		dump: {
+			result: MessagePort;
+		};
+	};
+	type MainMessages = {
+		sendPacket: {
+			connectionId: number;
+			packet: Uint8Array;
+		};
+		captureReady: {};
+		playbackReady: {};
+		stats: {
+			playback?: {
+				numberPackets: number;
+				numberPacketsMediaNotFound: number;
+				numberTicks: number;
+				numberPacketError: number;
+				numberTicksWithAudio: number;
+			};
+			capture?: {
+				numberPackets: number;
+				numberPacketsMediaNotFound: number;
+				numberTicks: number;
+				numberPacketError: number;
+			};
+		};
+	};
 }
-export declare class Room implements Backend.Room {
-    private readonly _Id;
-    private readonly _Connection;
-    private readonly _OnEvent;
-    private readonly _Captures;
-    private readonly _Playbacks;
-    private readonly _Peers;
-    private readonly _AvailableMediaIds;
-    get mainConnection(): MainConnection | undefined;
-    constructor(id: number, connectionPool: ConnectionPool, parameters: JoinRoomParameters);
-    get token(): string;
-    get cipher(): Cipher | undefined;
-    request(method: string, properties: unknown): Promise<unknown>;
-    link(media: Backend.Media): Promise<void>;
-    unlink(media: Backend.Media): void;
-    close(): void;
-    private _HandleEvent;
-    private _HandleKnownEvent;
-    private _HandleConnectionLost;
-    private _HandleRoomUpdate;
-    private _HandleRoomJoined;
-    private _HandlePeerUpdate;
-    private _HandlePeerJoined;
-    private _HandlePeerLeft;
-    private _HandleMediaStart;
-    private _HandleMediaStopped;
+export type OnLogMessage = (formattedString: string, record: LogRecord) => void;
+export interface VadConfig {
+	volumeGate?: {
+		attackThreshold: number;
+		releaseThreshold: number;
+	};
+	voiceActivity?: {
+		attackThreshold: number;
+		releaseThreshold: number;
+	};
 }
+export type ConnectionStats = {
+	numberRecvDatagrams: number;
+	numberRecvDatagramsNoMediaIds: number;
+	numberRecvDatagramsNoEntry: number;
+	numberRecvDatagramsDecryptInvalid: number;
+	mainConnectionIdHistory: number[];
+};
+export type AudioContextFactory = (sampleRate: number | undefined) => Promise<AudioContext>;
+export type MoreConnectionStats = ConnectionStats & {
+	numberAudioChannelMessages: number;
+};
+export interface WebDevice extends Backend.Device {
+	readonly device: MediaDeviceInfo;
+}
+export interface WebDeviceParameters extends Backend.DeviceParameters {
+	readonly device?: WebDevice;
+	onStatusChanged?: Backend.OnStatusChanged;
+}
+export declare function createPlugin(audioContextFactory: AudioContextFactory, options?: WebPluginOptions): WebPlugin;
+export interface WebPluginOptions {
+	logger?: Logger;
+	onLogMessage?: OnLogMessage;
+}
+export interface WebPlugin extends Backend.Plugin {
+	joinRoom(parameters: Backend.JoinRoomParameters): WebRoom;
+	enumerateDevices(): Promise<WebDevice[]>;
+	setOutputDevice(device: WebDeviceParameters): Promise<void>;
+	getAudioPlaybackStats(): undefined | Common.MainMessages["stats"]["playback"];
+	getConnectionStats(): MoreConnectionStats;
+}
+export interface WebRoom extends Backend.Room {
+}
+
+export {};