vobiz-webrtc-sdk

Vobiz WebRTC SDK

Introduction

The Vobiz Browser SDK enables browser-based voice calling through Vobiz's voice platform. It provides SIP registration, WebRTC-based calling, and audio device management.

Installation

NPM

npm install vobiz-webrtc-sdk --save 

Usage

You can import Browser SDK using ES module or TypeScript syntax

import Vobiz from 'vobiz-webrtc-sdk';

or using CommonJS

const Vobiz = require('vobiz-webrtc-sdk');

Prerequisite: Audio Element

To ensure reliable audio playback across all browsers, you must include an audio element in your HTML with the id remoteAudio.

<audio id="remoteAudio" autoplay></audio>

TypeScript Support

This Browser SDK package includes TypeScript declarations. We support projects using TypeScript versions >= 4.0.3.

Set Up Development Environment

Install dependencies

npm install

Build

You can create a minified or non-minified build:

npm run build

This command creates a minified, production-ready build at dist/vobiz-webrtc-sdk.min.js.

npm run build:nominify

This command creates a non-minified version of the build file at dist/vobiz-webrtc-sdk.js.

Start the development server

npm start

This command builds the SDK file and attaches it to port 9000 — http://localhost:9000/vobiz-webrtc-sdk.js. The project uses a webpack-dev-server that helps with live reloading.

Testing

Unit tests

npm run test:unit

Integration tests

Running integration tests requires some setup:

• Create a .env file in the root directory with endpoint credentials:

VOBIZ_ENDPOINT1_USERNAME=<Endpoint-1 Username>
VOBIZ_ENDPOINT1_PASSWORD=<Endpoint-1 Password>
VOBIZ_ENDPOINT2_USERNAME=<Endpoint-2 Username>
VOBIZ_ENDPOINT2_PASSWORD=<Endpoint-2 Password>

• After the setup, run integration tests:

npm run test:integration

License

See LICENSE