@apirtc/apirtc

ApiRTC

ApiRTC is real time web communication library. It will enable you to easily add communication (chat, audio, video, file transfer, drawings) into your application.

ApiRTC makes web communication easy as a breeze using ApiRTC's infrastructure and WebRTC technology.

One of main avantage of ApiRTC is to be compatible with lot of differents browsers and versions. ApiRTC keeps evolving with the support of new APIs and features on web browsers.

Changelog available on github.

Installation

npm i @apirtc/apirtc --save

or

yarn add @apirtc/apirtc

Usage

Module

import { UserAgent, Session } from '@apirtc/apirtc';

or

import apiRTC from '@apirtc/apirtc';

Eg:

let ua = new UserAgent({
    uri: "apzkey:myDemoApiKey",
});

let registerInformation = {
    cloudUrl: "https://cloud.apirtc.com",
};

ua.register(registerInformation)
    .then((session) => {
        console.log("User registered with session: ", session);
    })
    .catch((error) => {
        console.error("User agent registration failed", error);
    });

Global object

You can use apiRTC object from the global scope.

<script src="node_modules/@apirtc/apirtc/apiRTC.min.js"></script>

or

<script src="https://cloud.apirtc.com/apiRTC/apiRTC-latest.min.js"></script>

<script>
let ua = new apiRTC.UserAgent({
    uri: "apzkey:myDemoApiKey",
});
</script> 

Documentation

If you want to get started, you should take a look at our Getting started guide and API Quick start guide

We have also prepared a number of tutorials & samples to simplify the ApiRTC integration in your application.

API Reference Documentation