Conferencing

This document describes how to join conferences that are not protected by the conference access token. Joining protected conferences requires receiving the participant-specific conference access token via the conference invitation. For more information about protected conferences, see the Enhanced Conference Access Control document. For more information about using invitations, see the Inviting Participants document.

The Dolby.io Communications APIs platform requires obtaining the conference object before joining a conference. To obtain the conference object, your application can either use the create method with the conference alias or the fetch method with the conference ID.

The alias is a name that you define during the conference creation. The alias needs to be a logical and unique string that consists of up to 250 characters, such as letters, digits, and symbols other than #. The conference ID is established by the server and is available only through the conference object.

Note: When you create a conference, be aware that the conference time limit is set to three hours by default. You can change this setting in your dashboard.

Joining conferences using the conference alias

The simplest way to join a conference is to call the create and join methods. The create method creates a conference on a Dolby.io Communications APIs server and returns the conference object containing the conference ID. If a conference with a specific alias already exists on the server, the create method does not create a new conference; the method returns the conference object. Use the isNew parameter to see whether you have just created a new conference (true) or someone else has created it before you (false).

  1. Call the create method using the conference alias.
const createOptions = {
    alias: alias,
    params: {
        dolbyVoice: true,
    },
};
const conference = await VoxeetSDK.conference.create(createOptions);

Note: Use the dolbyVoice parameter only if you wish to create a Dolby Voice conference.

  1. Call the join method to the returned conference object to join the conference.
const constraints = {
    audio: true,
    video: true,
};
await VoxeetSDK.conference.join(conference, { constraints: constraints });

Joining conferences using the conference ID

The previous procedure required all conference participants to call the create method. The Dolby.io Communications APIs platform also offers the Create REST API that allows creating conferences from a backend. The javascript will request from the backend the ID of the conference to join, call the fetch method to obtain the conference object, and then call the join method to successfully join the conference.

  1. The application requests its backend for a conference ID.

  2. The application calls the fetch method to obtain the conference object.

const conference = await VoxeetSDK.conference.fetch(conferenceId);
  1. The application calls the join method to the returned conference object to join the conference.
const constraints = {
    audio: true,
    video: true,
};
await VoxeetSDK.conference.join(conference, { constraints: constraints });