Métodos

A continuación, exponemos los métodos disponibles con sus descripciones y argumentos disponibles.

create

Este método es asíncrono.

Este método permite crear una instancia de conexión WebRTC mediante un accessToken.

phone.addEventListener('answered', async event => {
    const { accessToken } = event;
    await webrtc.create(accessToken);
    // Do something
});

Este método recibe tres argumentos en el siguiente orden, siendo solo el primero obligatorio:

accessToken

Corresponde al token de conexión, el cual lo puedes obtener desde el evento answered de Phone SDK.

constraints (opcional)

Estas son las restricciones que se aplicarán al momento de obtener acceso a la cámara y/o micrófono.

const constraints = { audio: true, video: false }; // Only mic
await webrtc.create(accessToken, constraints);

stream (opcional)

Este argumento corresponde a un stream (MediaStream) de cámara y/o micrófono activo. Si el stream es válido omitirá el argumento constraints.

const camera = await navigator.mediaDevices.getUserMedia(...);
await webrtc.create(accessToken, null, camera);

destroy

Este método permite destruir una instancia WebRTC. Deberás utilizar este método en eventos que requieran crear una nueva instancia o terminada una llamada.

webrtc.destroy();

Este método recibe dos argumentos opcionales de tipo boolean donde el primero permite definir si detiene las pistas de cámara y micrófono, mientras que el segundo elimina el elemento DOM. Por defecto el valor del primer argumento es true, en el caso del segundo es false.

stopCamera

Este argumento es útil si deseas evitar detener el acceso a la cámara para disminuir el tiempo de carga en la siguiente instanciación.

Este método no destruye o elimina nodo DOM videsk-webrtc.

sendMessage

Este método permite enviar mensajes mediante el chat.

message

Recibe solo un argumento como String el cual será el cuerpo del mensaje.

webrtc.sendMessage('Hola, necesito ayuda!');

Los enlaces serán resaltados automáticamente.

Por seguridad, todo texto enviado será sanitizado, por lo que caracteres HTML serán escapados de forma automática.

addEventListener

Este método permite definir oyentes de eventos.

webrtc.addEventListener('hangup', () => {
    // Do something
});

Última actualización