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
conferenceInvitationRequest any - Emitted every time a request for an invitation to a conference room is received
conferenceInvitationRequestCancelled any -

Member Summary

Public Members
public	emitter: EventEmitter

Method Summary

Public Methods
public	createConference(): Promise<Conference> Creates a new conference room
public	async getConferenceByUri(uri: string): Promise<Conference> Get a Conference by uri
public	getConferenceLog(): ConferenceLog
public	getCurrentInvitations(): Promise<Conference[]> Asks the server for the current invitations available to the user
public	getDefaultMediaConstraints(): MediaStreamConstraints
public	requestConferenceInvitation(participant: string, mediaTypes: object): Promise<object>
public	setDefaultMediaConstraints(defaultMediaConstraints: MediaStreamConstraints) 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 createConference(): Promise<Conference> source

Creates a new conference room

Return:

Promise<Conference>

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

Get a Conference by uri

Params:

Name	Type	Attribute	Description
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

Return:

MediaStreamConstraints

public requestConferenceInvitation(participant: string, mediaTypes: object): Promise<object> source

Params:

Name	Type	Attribute	Description
participant	string
mediaTypes	object

Return:

Promise<object>

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:

Name	Type	Attribute	Description
defaultMediaConstraints	MediaStreamConstraints

Example:

Enabling noise reduction techniques

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