livekit-client/dist/src/api/WebSocketStream.d.ts

JavaScript/TypeScript client SDK for LiveKit

import { ConnectionError } from '../room/errors';
import TypedPromise from '../utils/TypedPromise';
export interface WebSocketConnection<T extends ArrayBuffer | string = ArrayBuffer | string> {
    readable: ReadableStream<T>;
    writable: WritableStream<T>;
    protocol: string;
    extensions: string;
}
export interface WebSocketCloseInfo {
    closeCode?: number;
    reason?: string;
}
export interface WebSocketStreamOptions {
    protocols?: string[];
    signal?: AbortSignal;
}
type WebsocketError = ReturnType<typeof ConnectionError.websocket>;
/**
 * [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) with [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API)
 *
 * @see https://web.dev/websocketstream/
 */
export declare class WebSocketStream<T extends ArrayBuffer | string = ArrayBuffer | string> {
    readonly url: string;
    readonly opened: TypedPromise<WebSocketConnection<T>, WebsocketError>;
    readonly closed: TypedPromise<WebSocketCloseInfo, WebsocketError>;
    readonly close: (closeInfo?: WebSocketCloseInfo) => void;
    get readyState(): number;
    private ws;
    constructor(url: string, options?: WebSocketStreamOptions);
}
export {};
//# sourceMappingURL=WebSocketStream.d.ts.map