@testrtc/watchrtc-sdk/lib/sdk.d.ts

Monitor your WebRTC application by collecting WebRTC statistics from end users

import { IEvent, IStatsCallback, IWatchRTCConfiguration, IWatchRTCInitServices, Rating, StateListener } from "./interfaces";
export declare const sdkLog: (level: "debug" | "info" | "error", message: string, object?: Object | undefined) => void;
export declare const sdkLogWithoutTrace: (level: "debug" | "info" | "error", message: string, object?: Object | undefined) => void;
/**
 * Initialize SDK.
 * @param watchrtc
 * @param prefixesToWrap
 * @param services
 */
export declare const initSDK: (watchrtc: Omit<IWatchRTCConfiguration, "allowBrowserLogCollection">, prefixesToWrap: string[], services?: IWatchRTCInitServices) => void;
export declare const setConfig: (newWatchrtcConfig: Omit<IWatchRTCConfiguration, "collectionInterval" | "allowBrowserLogCollection">) => void;
/**
 * Set user rating and/or comment for peer session
 * @param rating number from 1 to 5
 * @param comment string
 */
export declare const setUserRating: (rating: Rating, ratingComment?: string) => Promise<{
    error?: string;
}>;
/**
 * Add keys for peer session
 * @param keys
 */
export declare const addKeys: (keys: any) => Promise<unknown> | undefined;
export declare const disableDataCollection: () => void;
export declare const enableDataCollection: () => void;
export declare const addEvent: (event: IEvent) => Promise<unknown> | undefined;
export declare const mapStream: (id: string, name: string) => void;
export declare const mapTrack: (id: string, name: string) => void;
export declare const mapPC: (pc: any, displayName: string) => void;
export declare const connect: () => void;
export declare const disconnect: () => void;
export declare const registerOnStatsListener: (listener: IStatsCallback | null) => void;
export declare const registerStateListener: (listener: StateListener | null) => void;
export type SocketStatus = "connected" | "disconnected" | "reconnected" | "error" | "closed" | "connecting" | "reconecting";
export type AuthenticationStatus = "authenticated" | "invalid" | "expired" | "unauthenticated";
export declare class WatchRTCError extends Error {
    errorCode: string | number;
    socketStatus?: SocketStatus;
    authenticationStatus?: AuthenticationStatus;
    constructor(message: string, errorCode: string | number, socketStatus?: SocketStatus, authenticationStatus?: AuthenticationStatus);
}
interface SDKEventMap {
    onSocketConnect: [];
    onSocketError: [WatchRTCError];
    onSocketDisconnect: [number, string];
}
type AllowedEvent = keyof SDKEventMap;
type SDKEventListener<K extends AllowedEvent> = (...args: SDKEventMap[K]) => void;
/**
 * Subscribe to SDK events (only allowed events, strongly typed)
 */
export declare function subscribe<K extends AllowedEvent>(event: K, listener: SDKEventListener<K>): void;
/**
 * Unsubscribe from SDK events
 */
export declare function unsubscribe<K extends AllowedEvent>(event: K, listener: SDKEventListener<K>): void;
export declare const persistentEnd: (nailUpCallEnd?: boolean) => void;
export declare const persistentStart: (roomId: string, peerId: string) => void;
export declare const qrtcRun: ({ options, progressCallback, }: {
    options?: Record<string, any> | undefined;
    progressCallback: (progress: number) => void;
}) => Promise<any>;
export declare const qrtcStop: () => void;
export {};