Home Reference Source
import {ConferenceManager} from '@quobis/sippojs'
public class | source

ConferenceManager

This class provides access to every conference related feature This class must never be directly instantiated, instances of this class can be obtained using Session#getConferenceManager.

Events

  • conferenceInvitation Conference - Emitted every time an invitation to a conference room is received

Member Summary

Public Members
public

emitter: EventEmitter

Method Summary

Public Methods
public

async callAgent(mediaTypes: MediaTypes, contextInfo: Object): Promise<Conference>

Creates a new conference and invites an agent to it

public

Creates a new conference room

public
this method was deprecated. Use "getMeetingConference" or "getQuickConference" instead

Get a Conference by uri

public
public

Asks the server for the current invitations available to the user

public
public

async getMeetingConference(meetingId: string, password: string): Promise<Conference>

Get a conference for a meeting

public

async getQuickConference(quickConferenceId: string): Promise<Conference>

Gets a quick conference

public

Sets the constraints that will be used as initial value for media requests when initializing conferences.

Public Members

public emitter: EventEmitter source

Public Methods

public async callAgent(mediaTypes: MediaTypes, contextInfo: Object): Promise<Conference> source

Creates a new conference and invites an agent to it

Params:

NameTypeAttributeDescription
mediaTypes MediaTypes

the media types that will be used to call an agent

contextInfo Object
  • optional
  • default: {}

arbitrary context that can be sent to an agent

Return:

Promise<Conference>

public async createConference(): Promise<Conference> source

Creates a new conference room

Return:

Promise<Conference>

public async getConferenceByUri(uri: string): Promise<Conference> source

this method was deprecated. Use "getMeetingConference" or "getQuickConference" instead

Get a Conference by uri

Params:

NameTypeAttributeDescription
uri string

Return:

Promise<Conference>

fulfilled when the response is received

public getConferenceLog(): ConferenceLog source

Return:

ConferenceLog

public getCurrentInvitations(): Promise<Conference[]> source

Asks the server for the current invitations available to the user

Return:

Promise<Conference[]>

public getDefaultMediaConstraints(): MediaStreamConstraints source

public async getMeetingConference(meetingId: string, password: string): Promise<Conference> source

Get a conference for a meeting

Params:

NameTypeAttributeDescription
meetingId string
password string
  • optional

Return:

Promise<Conference>

fulfilled when the response is received

Throw:

AccessBeforeTimeError

thrown when trying to access the conference before scheduled time

WrongPasswordError

thrown when the conference is protected by password and the password is not recived or is not valid.

public async getQuickConference(quickConferenceId: string): Promise<Conference> source

Gets a quick conference

Params:

NameTypeAttributeDescription
quickConferenceId string

Return:

Promise<Conference>

fulfilled when the response is received

public setDefaultMediaConstraints(defaultMediaConstraints: MediaStreamConstraints) source

Sets the constraints that will be used as initial value for media requests when initializing conferences. For more information about valid values see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints

Params:

NameTypeAttributeDescription
defaultMediaConstraints MediaStreamConstraints

Example:

Enabling noise reduction techniques
conferenceManager.setDefaultMediaConstraints({
  audio: {
    autoGainControl: true,
    echoCancellation: true,
    noiseSuppression: true,
  },
  video: true,
});