Class 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

Hierarchy

  • ConferenceManager

Properties

conferenceLog? conferenceLogService conferenceService conferences defaultMediaConstraints emitter ownId permissionManager

Methods

createConference getConferenceForRoom getConferenceLog getCurrentInvitations getDefaultMediaConstraints getMeetingConference getQuickConference onIncomingConference setDefaultMediaConstraints

Properties

Private Optional conferenceLog

conferenceLog?: ConferenceLog

Private conferenceLogService

conferenceLogService: ConferenceLogService

Private conferenceService

conferenceService: Conferences

conferences

conferences: Map<any, any> = ...

Private defaultMediaConstraints

defaultMediaConstraints: MediaStreamConstraints = ...

emitter

emitter: EventEmitter<Events, any> = ...

Private ownId

ownId: string

Private permissionManager

permissionManager: PermissionManager

Methods

createConference

  • Creates a new conference room

    Parameters

    • options: {
          recording?: boolean;
      } = ...
      • Optional recording?: boolean

        boolean indicating whether the conference is going to be recorded or not. This applies only if the user has canSetRecordOption permission

    Returns Promise<Conference>

Private getConferenceForRoom

getConferenceLog

getCurrentInvitations

getDefaultMediaConstraints

  • Returns current media constraints used by default when creating conferences

    Returns MediaStreamConstraints

getMeetingConference

  • Get a conference for a meeting

    Returns

    fulfilled when the response is received

    Throws

    thrown when trying to access the conference before scheduled time

    Throws

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

    Parameters

    • meetingId: string
    • Optional password: string

    Returns Promise<Conference>

getQuickConference

Private onIncomingConference

setDefaultMediaConstraints

  • 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

    Example

    Enabling noise reduction techniques

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

    Parameters

    • defaultMediaConstraints: MediaStreamConstraints

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc