@vonage/voice
Version:
The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls.
40 lines • 1.59 kB
TypeScript
import { WebsocketBitrate } from '../../enums';
import { WebsocketEndpoint as WebsocketEndpointType } from '../../types/Endpoint/WebsocketEndpoint';
/**
* Represents a WebSocket endpoint for making voice calls.
*
* @deprecated This class is deprecated. Please update to use the WebsocketEndpointType type instead.
*/
export declare class WebsocketEndpoint implements WebsocketEndpointType {
/**
* The type of the endpoint, which is always 'websocket'.
*/
type: 'websocket';
/**
* The WebSocket URI associated with this endpoint.
*
* @param {string} uri - The WebSocket URI for the WebSocket endpoint.
*/
uri: string;
/**
* The content type or bitrate for WebSocket streaming.
*
* @param {WebsocketBitrate} contentType - The content type or bitrate for WebSocket streaming.
*/
contentType: WebsocketBitrate;
/**
* Optional custom headers to include in WebSocket requests.
*
* @param {Record<string, unknown>} headers - Optional custom headers as key-value pairs.
*/
headers?: Record<string, unknown>;
/**
* Create a new WebsocketEndpoint instance.
*
* @param {string} uri - The WebSocket URI for the WebSocket endpoint.
* @param {WebsocketBitrate} contentType - The content type or bitrate for WebSocket streaming.
* @param {Record<string, unknown>} headers - Optional custom headers as key-value pairs.
*/
constructor(uri: string, contentType: WebsocketBitrate, headers?: Record<string, unknown>);
}
//# sourceMappingURL=WebsocketEndpoint.d.ts.map