@observertc/observer-js 1.0.0-beta.8 → 1.0.0-beta.9

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter } from 'events';
+import { types } from 'mediasoup';
 
 /**
 * The WebRTC app provided custom stats payload
@@ -2082,6 +2083,179 @@ type ClientSampleSinkFactory = (params: {
     observedCall: ObservedCall;
 }) => ClientSampleSink | undefined;
 
+/** mediasoup `TransportTuple` (the selected local/remote address pair of a transport). */
+type TransportTuple = {
+    localAddress: string;
+    localPort: number;
+    remoteIp?: string;
+    remotePort?: number;
+    protocol: 'udp' | 'tcp';
+};
+/** mediasoup `RtpCodecParameters` (the negotiated codec of a producer/consumer). */
+type RtpCodecParameters = {
+    mimeType: string;
+    payloadType: number;
+    clockRate: number;
+    channels?: number;
+    parameters?: Record<string, unknown>;
+    rtcpFeedback?: {
+        type: string;
+        parameter?: string;
+    }[];
+};
+type SampleHistoryItem<T extends string> = Record<string, unknown> & {
+    type: T;
+    timestamp: number;
+};
+type MediasoupRouterSample = Record<string, unknown> & {
+    routerId: string;
+    attachments: Record<string, unknown>;
+    createdAt: number;
+    closedAt?: number;
+    producers: MediasoupProducerSample[];
+    consumers: MediasoupConsumerSample[];
+    dataProducers: MediasoupDataProducerSample[];
+    dataConsumers: MediasoupDataConsumerSample[];
+    transports: MediasoupTransportSample[];
+};
+type MediasoupWebRtcTransportSampleEventTypes = 'icestate-changed-to-new' | 'icestate-changed-to-connected' | 'icestate-changed-to-completed' | 'icestate-changed-to-disconnected' | 'icestate-changed-to-closed' | 'dtlsstate-changed-to-new' | 'dtlsstate-changed-to-connecting' | 'dtlsstate-changed-to-connected' | 'dtlsstate-changed-to-failed' | 'dtlsstate-changed-to-closed' | 'sctpstate-changed-to-new' | 'sctpstate-changed-to-connecting' | 'sctpstate-changed-to-connected' | 'sctpstate-changed-to-failed' | 'sctpstate-changed-to-closed' | 'iceselectedtuple-changed';
+type MediasoupWebRtcTransportSampleEventMap = {
+    [K in MediasoupWebRtcTransportSampleEventTypes]: SampleHistoryItem<K>;
+}[MediasoupWebRtcTransportSampleEventTypes];
+type MediasoupWebRtcTransportSample = {
+    type: 'webrtc';
+    history: MediasoupWebRtcTransportSampleEventMap[];
+};
+type MediasoupPlainTransportSampleEventTypes = 'sctpstate-changed-to-new' | 'sctpstate-changed-to-connecting' | 'sctpstate-changed-to-connected' | 'sctpstate-changed-to-failed' | 'sctpstate-changed-to-closed' | 'tuple-changed' | 'rtcptuple-changed';
+type MediasoupPlainTransportSampleEventMap = {
+    [K in MediasoupPlainTransportSampleEventTypes]: SampleHistoryItem<K>;
+}[MediasoupPlainTransportSampleEventTypes];
+type MediasoupPlainTransportSample = {
+    type: 'plain';
+    rtcpTuple?: TransportTuple;
+    history: MediasoupPlainTransportSampleEventMap[];
+};
+type MediasoupPipeTransportSampleEventTypes = 'sctpstate-changed-to-new' | 'sctpstate-changed-to-connecting' | 'sctpstate-changed-to-connected' | 'sctpstate-changed-to-failed' | 'sctpstate-changed-to-closed';
+type MediasoupPipeTransportSampleEventMap = {
+    [K in MediasoupPipeTransportSampleEventTypes]: SampleHistoryItem<K>;
+}[MediasoupPipeTransportSampleEventTypes];
+type MediasoupPipeTransportSample = {
+    type: 'pipe';
+    history: MediasoupPipeTransportSampleEventMap[];
+};
+type MediasoupDirectTransportSampleEventTypes = never;
+type MediasoupDirectTransportSampleEventMap = {
+    [K in MediasoupDirectTransportSampleEventTypes]: SampleHistoryItem<K>;
+}[MediasoupDirectTransportSampleEventTypes];
+type MediasoupDirectTransportSample = {
+    type: 'direct';
+    history: MediasoupDirectTransportSampleEventMap[];
+};
+type MediasoupTransportSample = Record<string, unknown> & {
+    id: string;
+    createdAt: number;
+    connectedAt?: number;
+    closedAt?: number;
+    tuple?: TransportTuple;
+} & (MediasoupWebRtcTransportSample | MediasoupPlainTransportSample | MediasoupPipeTransportSample | MediasoupDirectTransportSample);
+type MediasoupProducerSampleEventMap = {
+    'pause': undefined;
+    'resume': undefined;
+    'degraded': undefined;
+    'restored': undefined;
+};
+type MediasoupProducerSampleEvent = {
+    [K in keyof MediasoupProducerSampleEventMap]: SampleHistoryItem<K>;
+}[keyof MediasoupProducerSampleEventMap];
+type MediasoupProducerSample = Record<string, unknown> & {
+    id: string;
+    transportId: string;
+    createdAt: number;
+    closedAt?: number;
+    codecInfo: RtpCodecParameters;
+    kind: 'audio' | 'video';
+    ssrcs?: number[];
+    rids?: string[];
+    history: MediasoupProducerSampleEvent[];
+};
+type MediasoupConsumerSampleEventMap = {
+    'pause': undefined;
+    'resume': undefined;
+    'producerPaused': undefined;
+    'producerResumed': undefined;
+    'stopped': undefined;
+    'started': undefined;
+    'degraded': undefined;
+    'restored': undefined;
+};
+type MediasoupConsumerSampleEvent = {
+    [K in keyof MediasoupConsumerSampleEventMap]: SampleHistoryItem<K>;
+}[keyof MediasoupConsumerSampleEventMap];
+type MediasoupConsumerSample = Record<string, unknown> & {
+    id: string;
+    producerId: string;
+    transportId: string;
+    createdAt: number;
+    closedAt?: number;
+    kind: 'audio' | 'video';
+    history: MediasoupConsumerSampleEvent[];
+};
+type MediasoupDataProducerSample = Record<string, unknown> & {
+    id: string;
+    transportId: string;
+    createdAt: number;
+    closedAt?: number;
+    label: string;
+    protocol: string;
+};
+type MediasoupDataConsumerSample = Record<string, unknown> & {
+    id: string;
+    dataProducerId: string;
+    transportId: string;
+    createdAt: number;
+    closedAt?: number;
+    label: string;
+    protocol: string;
+};
+
+type ObservedMediasoupRouterSettings<AppData extends Record<string, unknown> = Record<string, unknown>> = {
+    routerId: string;
+    router: types.Router;
+    appData?: AppData;
+    attachments?: Record<string, unknown>;
+};
+type ObservedMediasoupRouterEvents = {
+    close: [];
+};
+declare interface ObservedMediasoupRouter {
+    on<U extends keyof ObservedMediasoupRouterEvents>(event: U, listener: (...args: ObservedMediasoupRouterEvents[U]) => void): this;
+    off<U extends keyof ObservedMediasoupRouterEvents>(event: U, listener: (...args: ObservedMediasoupRouterEvents[U]) => void): this;
+    once<U extends keyof ObservedMediasoupRouterEvents>(event: U, listener: (...args: ObservedMediasoupRouterEvents[U]) => void): this;
+    emit<U extends keyof ObservedMediasoupRouterEvents>(event: U, ...args: ObservedMediasoupRouterEvents[U]): boolean;
+}
+declare class ObservedMediasoupRouter<AppData extends Record<string, unknown> = Record<string, unknown>> extends EventEmitter {
+    readonly router: types.Router;
+    readonly sample: MediasoupRouterSample;
+    appData: AppData;
+    readonly webrtcTransportIds: Set<string>;
+    get attachments(): Record<string, unknown>;
+    closed: boolean;
+    constructor(settings: ObservedMediasoupRouterSettings<AppData>);
+    get id(): string;
+    addTransport: (transport: types.Transport) => void;
+    addWebRtcTransport(transport: types.WebRtcTransport): void;
+    addPlainTransport(transport: types.PlainTransport): void;
+    addPipeTransport(transport: types.PipeTransport): void;
+    addDirectTransport(transport: types.DirectTransport): void;
+    addProducer(transport: types.Transport, producer: types.Producer): void;
+    addConsumer(transport: types.Transport, consumer: types.Consumer): void;
+    addDataProducer(transport: types.Transport, dataProducer: types.DataProducer): void;
+    addDataConsumer(transport: types.Transport, dataConsumer: types.DataConsumer): void;
+    close(): void;
+    private attachRouterListeners;
+    private _attachTransportObserverListeners;
+}
+
 /**
  * The Observer is the single event bus for the whole hierarchy. Every event
  * worth subscribing to is emitted on the Observer with a payload object that
@@ -2109,6 +2283,9 @@ type ObservedClientScope = ObservedCallScope & {
 type ObservedPeerConnectionScope = ObservedClientScope & {
     observedPeerConnection: ObservedPeerConnection;
 };
+type ObservedMediasoupRouterScope = Omit<ObserverEventBase, 'context'> & {
+    observedMediasoupRouter: ObservedMediasoupRouter;
+};
 type ObserverEvents = {
     'observer-updated': [ObserverEventBase];
     'observer-closed': [ObserverEventBase];
@@ -2116,6 +2293,9 @@ type ObserverEvents = {
         reason: SampleRejectedReason;
         sample: ClientSample;
     }];
+    'mediasoup-router-added': [ObservedMediasoupRouterScope];
+    'mediasoup-router-removed': [ObservedMediasoupRouterScope];
+    'mediasoup-router-matched-with-call': [ObservedMediasoupRouterScope & ObservedCallScope];
     'call-added': [ObservedCallScope];
     'call-updated': [ObservedCallScope];
     'call-closed': [ObservedCallScope];
@@ -2636,6 +2816,7 @@ declare class Observer<AppData extends Record<string, unknown> = Record<string,
     readonly config: ObserverConfig<AppData>;
     readonly observedTURN: ObservedTURN;
     readonly observedCalls: Map<string, ObservedCall<Record<string, unknown>>>;
+    readonly observedMediasoupRouters: Map<string, ObservedMediasoupRouter<Record<string, unknown>>>;
     updater?: Updater;
     /** Ancestry base shared by all Observer-bus events originating at the observer. */
     readonly eventScope: ObserverEventBase;
@@ -2656,6 +2837,10 @@ declare class Observer<AppData extends Record<string, unknown> = Record<string,
     getObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(callId: string): ObservedCall<T> | undefined;
     createObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedCallSettings<T>): ObservedCall<T> | undefined;
     getOrCreateObservedCall<T extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedCallSettings<T>): ObservedCall<T> | undefined;
+    createObservedMediasoupRouter<T extends Record<string, unknown> = Record<string, unknown>>(settings: ObservedMediasoupRouterSettings<T> & {
+        callId?: string;
+        bindCallByWebRtcTransportId?: boolean;
+    }): ObservedMediasoupRouter<Record<string, unknown>> | undefined;
     close(): void;
     accept(sample: ClientSample, context?: AcceptContext): void;
     update(): void;
@@ -2768,4 +2953,4 @@ declare function createInMemorySink(samples?: ClientSample[]): InMemorySink;
 declare function createDefaultMediasoupRemoteTrackResolverFactory(): RemoteTrackResolverFactory;
 declare function createP2pRemoteTrackResolverFactory(): RemoteTrackResolverFactory;
 
-export { type AcceptContext, type AcceptMiddleware, type AcceptMiddlewarePayload, type CallAppDataFactory, type ClientAppDataFactory, type ClientEvent, ClientEventTypes, type ClientIssue, type ClientMetaData, ClientMetaTypes, type ClientSample, ClientSampleSink, type ClientSampleSinkEvents, type ClientSampleSinkFactory, type Detector, Detectors, InMemorySink, JsonlFileSink, type JsonlFileSinkFactoryOptions, type JsonlFileSinkOptions, type Logger, type Middleware, ObservedCall, type ObservedCallScope, ObservedCertificate, ObservedClient, type ObservedClientScope, ObservedCodec, ObservedDataChannel, ObservedIceCandidate, ObservedIceCandidatePair, ObservedIceTransport, ObservedInboundRtp, ObservedInboundTrack, ObservedMediaPlayout, ObservedMediaSource, ObservedOutboundRtp, ObservedOutboundTrack, ObservedPeerConnection, type ObservedPeerConnectionScope, ObservedPeerConnectionTransport, ObservedRemoteInboundRtp, ObservedRemoteOutboundRtp, Observer, type ObserverEventBase, type ObserverEvents, type ObserverLogger, RemoteTrackResolver, type RemoteTrackResolverFactory, type RemoteTrackResolvers, type SampleRejectedReason, type ScoreCalculator, createDefaultMediasoupRemoteTrackResolverFactory, createInMemorySink, createJsonlFileSink, createJsonlFileSinkFactory, createLogger, createP2pRemoteTrackResolverFactory, setObserverLogger };
+export { type AcceptContext, type AcceptMiddleware, type AcceptMiddlewarePayload, type CallAppDataFactory, type ClientAppDataFactory, type ClientEvent, ClientEventTypes, type ClientIssue, type ClientMetaData, ClientMetaTypes, type ClientSample, ClientSampleSink, type ClientSampleSinkEvents, type ClientSampleSinkFactory, type Detector, Detectors, InMemorySink, JsonlFileSink, type JsonlFileSinkFactoryOptions, type JsonlFileSinkOptions, type Logger, type MediasoupConsumerSample, type MediasoupConsumerSampleEvent, type MediasoupDataConsumerSample, type MediasoupDataProducerSample, type MediasoupDirectTransportSample, type MediasoupDirectTransportSampleEventMap, type MediasoupPipeTransportSample, type MediasoupPipeTransportSampleEventMap, type MediasoupPlainTransportSample, type MediasoupPlainTransportSampleEventMap, type MediasoupProducerSample, type MediasoupProducerSampleEvent, type MediasoupRouterSample, type MediasoupTransportSample, type MediasoupWebRtcTransportSample, type MediasoupWebRtcTransportSampleEventMap, type Middleware, ObservedCall, type ObservedCallScope, ObservedCertificate, ObservedClient, type ObservedClientScope, ObservedCodec, ObservedDataChannel, ObservedIceCandidate, ObservedIceCandidatePair, ObservedIceTransport, ObservedInboundRtp, ObservedInboundTrack, ObservedMediaPlayout, ObservedMediaSource, ObservedMediasoupRouter, type ObservedMediasoupRouterEvents, type ObservedMediasoupRouterScope, type ObservedMediasoupRouterSettings, ObservedOutboundRtp, ObservedOutboundTrack, ObservedPeerConnection, type ObservedPeerConnectionScope, ObservedPeerConnectionTransport, ObservedRemoteInboundRtp, ObservedRemoteOutboundRtp, Observer, type ObserverEventBase, type ObserverEvents, type ObserverLogger, RemoteTrackResolver, type RemoteTrackResolverFactory, type RemoteTrackResolvers, type SampleRejectedReason, type ScoreCalculator, createDefaultMediasoupRemoteTrackResolverFactory, createInMemorySink, createJsonlFileSink, createJsonlFileSinkFactory, createLogger, createP2pRemoteTrackResolverFactory, setObserverLogger };