qcall v1.0.6

QCall

Complete example

//Example of video tag
    <video
      srcObject="VIDEO_STREAM"
      id="myVideo"
      height="720"
      width="1280"
      autoplay
      controls
    ></video>

Install QCall With npm

 npm install qcall

With yarn

 yarn add qcall

Room Builder

Builder class wich allows you to create a Room instance with the build pattern. By default this class has the current constraints:

    /**
     * Room Builder cconstruct
     * @class
     * @param {String} id The room id
     * @param {String} deploy The scope provded to you by Quilo S.A.
     * @param {String} apiKey The api key provded to you by Quilo S.A.
     */
constructor(id, deploy, apiKey = null)

• VideoConstraints: - Height - max: VideoQualities.HD.height = 720px - min: VideoQualities.LOW.height = 360px - ideal: VideoQualities.SD.height = 480px
  • Width
    • max: VideoQualities.HD.width = 1280px - min: VideoQualities.LOW.width = 480px - ideal: VideoQualities.SD.width = 640px - Frame Rate (fps)
    • max: FrameRates.HIGH = 45fps - min: FrameRates.LOW = 15fps - ideal: FrameRates.STANDARD = 25fps
• withAudio = True

Functions

Examples

Basic Example

import { RoomBuilder } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
        .setMetadata({ name: "Augusto Alonso" })
        .build()

Example defining custom video quility

import { RoomBuilder, VideoQualities } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
        .setMetadata({ name: "Paquito Pedroza" })
        .setMaxVideoQuality(VideoQualities.FULL_HD)
        .setMinVideoQuality(VideoQualities.HD)
        .setIdealVideoQuality(VideoQualities.FULL_HD)
        .build()
/* Another way to build it with custom video quality
is by passing an object with the width and height dimensions in pixels
**/
const FourK = { width: 3840, height: 2160 }
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
        .setMetadata({ name: "Paquito Pedroza" })
        .setMaxVideoQuality(FourK)
        .build()

Example defining custom frame rate

import { RoomBuilder, VideoQualities, FrameRates } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
        .setMetadata({ name: "Paquito Pedroza" })
        .setMaxVideoQuality(VideoQualities.FULL_HD)
       	.setMinFrameRate(FrameRates.GOOD)
        .setIdealFrameRate(FrameRates.HIGH)
        .setMaxFrameRate(FrameRates.MAX)
        .build()
/* Another way is passing the raw frame rate value desired **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
        .setMaxFrameRate(35)
        .build()

Want to stream without audio

import { RoomBuilder } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
		.setWithAudtio(false)       
        .build()

Setting a onStreamDennied callback for our Room class

import { RoomBuilder } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
		.setMetadata({ name: 'Juice WRLD', profession: 'Musician'})
		.setOnStreamDennied((data, error) => {
        //Function where you alert and show an alert that the user MUST give 
        //the permission to the web page to record the camera and microphone
        	alertUserPermissionsNeeded()
            console.log(`The ${data.profession} ${data.name} did not consent permission to record`)
            //Output:
            //The Musician Juice WRLD did not consent permission to record
        })       
        .build()

Want to specify custom peerId (each one must be unique by default an uuid is set)

import { RoomBuilder } from "qcall";
/* Creates an instance of Room Class **/
const room = new RoomBuilder('roomId', 'deploy', 'apiKey')
		.setPeerId(user.id)       
        .build()

Room Class

Properties

Functions

Client Class

Properties

Diagram of callbacks in Room Builder Class