Skip to main content

Getting Started

This guide gives you an overview of how to build video applications using ProCONF Twilio Adapter. So let's get started.

Setup for Development​

These steps guide you through setting up the development environment for the ProCONF Web SDK.

  • Get ProCONF SDK Adapter distribution bundle.

  • Unzip the bundle.

  • To start using the ProCONF SDK Adapter with client application, install the unzipped bundle as a dependency in the application.

npm install `$PATH_TO_DISTRIBUTION_BUNDLE`

Start using the ProCONF Adapter in your apps, with appropriate imports, as

  const Video = require('proconf-twilio-adapter');
  OR
  const { connect } = require('proconf-twilio-adapter');

API Usage Guide​

Create and connect to Room​

To create and join a room, use Video.connect method, which requires two parameters

  • proconfToken - Your ProCONF SDK adapter token
  • ConnectOptions - Optional, The options for the connecting room

The connect function returns a promise. When resolved, the room will be created on the server, and it will return an instance of Room.

    const Video = require('proconf-twilio-adapter');

    const room = await Video.connect(proconfToken, {
      audio: true,
      video: true,
    });

Create Local Audio Track​

To get local audio track, use Video.createLocalAudioTrack method, that requires constraints as parameter.

  • constraints - The constraints for the creating local audio track

This method returns a promise. When resolved, the local audio track will be created, and it will return an instance of Track.

      const Video = require('proconf-twilio-adapter');

      const audioTrack = await Video.createLocalAudioTrack({
        deviceId: { exact: deviceId }
      });

Create Local Video Track​

To get local video track, use Video.createLocalVideoTrack method, that takes constraints as parameter

  • constraints - The constraints for the creating local video track

This method returns a promise. When resolved, the local video track will be created, and it will return an instance of Track.

      const Video = require('proconf-twilio-adapter');

      const videoTrack = await Video.createLocalVideoTrack({
        width: 640,
        height: 360
      });

Note: For the complete APIs on the objects like Connection, Room, Participant, Track, etc. refer comprehensive guides and API reference under ProCONF Web SDK documentation.