2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

Conferencing

This document describes the process of creating and joining conferences.

Participating in a conference requires getting the conference object before joining. There are two ways to obtain the conference object; you can either use the create method with the external ID or the fetch method with the internal ID.

The Dolby Interactivity APIs use two types of IDs:

  • External ID: the customer-specified alias that identifies one, or a number of conferences. To set the alias, select a logical and unique string; you can use letters, digits, and symbols other than #. The maximum number of characters is 250.
  • Internal ID: the conference ID established by the server.

Note: By default, the conference time limit is three hours.

Creating and joining conferences using the conference alias

This procedure requires all the application users to call the create and join methods to join a conference. This procedure is not available on Android.

  • JavaScript
  • Swift

  1. Call the create method using the the conference alias.
VoxeetSDK.conference.create({ alias: ExampleAlias })

This method creates a conference on a Dolby Interactivity APIs server and returns the conference object containing the internal conference ID. If a conference with a specific alias already exists on a server, the create method does not create a new conference; it returns the conference object. Check the isNew parameter to see whether you have just created the conference (true) or someone else has created it before you (false).

  1. Call the join method to the returned conference object to join the conference.

Note: You may select the audio and video constraints before joining.

const constraints = { audio: true, video: true }

VoxeetSDK.conference
  .join(conference, { constraints: constraints })
  .then(info => {})
  .catch(error => {})

  1. Call the create method using the the conference alias.
let options = VTConferenceOptions()
options.alias = ExampleAlias
 
VoxeetSDK.shared.conference.create(options: options, success: { conference in }, fail: { error in })

This method creates a conference on a Dolby Interactivity APIs server and returns the conference object containing the internal conference ID. If a conference with a specific alias already exists on a server, the create method does not create a new conference; it returns the conference object. Check the isNew parameter to see whether you have just created the conference (true) or someone else has created it before you (false).

  1. Call the join method to the returned conference object to join the conference.

Note: You may select the audio and video constraints before joining.

let options = VTJoinOptions()
options.constraints.video = false

VoxeetSDK.shared.conference.join(conference: conference, options: joinOptions, success: { conference in }, fail: { error in })

Creating and joining conferences using the conference ID

This procedure requires the application users to create a conference and use the received internal conference ID to fetch the conference object and join the conference.

  • JavaScript
  • Swift
  • Java

  1. Call the create method using the the conference alias.
VoxeetSDK.conference.create({ alias: ExampleAlias })

This method creates a conference on a Dolby Interactivity APIs server and returns the conference object containing the internal conference ID. If a conference with a specific alias already exists on a server, the create method does not create a new conference; it returns the conference object. Check the isNew parameter to see whether you have just created the conference (true) or someone else has created it before you (false).

  1. Send the internal conference ID to the application users who should join the conference.
  2. The application users who have received the conference ID call the fetch method to get the conference object.
VoxeetSDK.conference.fetch((conferenceId: ConferenceId))
  1. Call the join method to the returned conference object to join a conference.

Note: You may select the audio and video constraints before joining.

const constraints = {
  audio: true,
  video: {
    width: {
      min: "320",
      max: "1280",
    },
    height: {
      min: "240",
      max: "720",
    },
  },
}

var constraints = { audio: true, video: true }

VoxeetSDK.conference
  .join((conference: Conference), {})
  .then(info => {})
  .catch(error => {})

  1. Call the create method using the the conference alias.
let options = VTConferenceOptions()
options.alias = ExampleAlias
 
VoxeetSDK.shared.conference.create(options: options, success: { conference in }, fail: { error in })

This method creates a conference on a Dolby Interactivity APIs server and returns the conference object containing the internal conference ID. If a conference with a specific alias already exists on a server, the create method does not create a new conference; it returns the conference object. Check the isNew parameter to see whether you have just created the conference (true) or someone else has created it before you (false).

  1. Send the internal conference ID to the application users who should join the conference.
  2. The application users who have received the conference ID call the fetch method to get the conference object.
VoxeetSDK.shared.conference.fetch(conferenceID: conferenceId) { conference in }
  1. Call the join method to the returned conference object to join a conference.

Note: You may select the audio and video constraints before joining.

let options = VTJoinOptions()
options.constraints.video = false

VoxeetSDK.shared.conference.join(conference: conference, options: joinOptions, success: { conference in }, fail: { error in })

  1. Call the create method using the conference alias.
VoxeetSDK.conference().create(ExampleAlias).then(createConferenceresult -> {
  //manage the success here
}).error(error -> {
  //manage the error here
});

This method creates a conference on a Dolby Interactivity APIs server and returns the getConferenceStatus containing the internal conference ID. If a conference with a specific alias already exists on a server, the create method does not create a new conference. Check the isNew parameter to see whether you have just created the conference (true) or someone else has created it before you (false).

  1. Call the fetchConference method using the received internal conference ID. This method gets the conference object.
String conferenceId = "conferenceId";
VoxeetSDK.conference().fetchConference(conferenceId).then(status -> {
  Log.d("SAMPLE", "conferenceId := " + getId() +" / conferenceAlias := " + conference.getAlias());
}).error(error -> {
  //manage the error here
});
  1. Call the join method to the returned conference object to join a conference.
VoxeetSDK.conference().join(conference).then(success -> {

}).error(error -> {
  //manage the error here
});