Class Conference

attendedTransferTarget$

audioStream$

isAttendedTransferActive$

Readonly localMediaHandler

localParticipant$

muteRequest$

participantsMap$

remoteParticipants$

status$

id

• get id(): string

• Returns the ID of the conference

  Returns string

invite

• get invite(): undefined | ConferenceInvite

• Returns the invitation to the conference if the participant was invited.

  Returns undefined | ConferenceInvite

isRecorded

• get isRecorded(): boolean

• Indicates if the conference is being recorded

  Returns boolean

joinTimestamp

• get joinTimestamp(): undefined | number

• The timestamp when the join to this conference was completed

  Returns undefined | number

status

• get status(): ConferenceStatus

• Returns the current status of the conference

  Returns ConferenceStatus

callVoiceMail

• callVoiceMail(mediaTypes?): Promise<{
      code: number;
      whoAccepted?: string;
  }>

• Invites the voicemail to a conference

  Parameters

  • Optional mediaTypes: MediaTypes

    the media types that will be used to call the voicemail

  Returns Promise<{
      code: number;
      whoAccepted?: string;
  }>

cancelAttendedTransfer

• cancelAttendedTransfer(): Promise<void>

• Cancels the in progress attended call transfer.

  Returns Promise<void>

executeAttendedTransfer

• executeAttendedTransfer(): Promise<void>

• Executes the in progress attended call transfer.

  Returns Promise<void>

expelParticipant

• expelParticipant(userId, session?): Promise<void>

• Expels a participant from this conference

  Parameters

  • userId: string
  • Optional session: string

  Returns Promise<void>

expelParticipants

• expelParticipants(participants): Promise<void>

• Expels a list of participant from this conference

  Parameters

  • participants: string[]

  Returns Promise<void>

hold

• hold(): Promise<void>

• Local hold Stop publishing and subscribing to the media in the conference

  Returns Promise<void>

inviteParticipant

• inviteParticipant(participant, mediaTypes?, context?): Promise<{
      code: number;
      whoAccepted?: string;
  }>

• Invites a new participant to this conference

  Parameters

  • participant: string

    A participant can be both an internal or an external user.
  • Optional mediaTypes: Readonly<MediaTypes>

    the MediaTypes of this invitation
  • context: Record<string, string> = {}

    Arbitrary context that can be sent when making an invite

  Returns Promise<{
      code: number;
      whoAccepted?: string;
  }>

  A promise with an object with two properties: SIP code (SIP code of the response) and whoAccepted (User id of the participant that accepted the invite).

inviteParticipants

• inviteParticipants(participants, mediaTypes?): Promise<{
      code: number;
      whoAccepted?: string;
  }[]>

• Invites a list of new participant to this conference

  Parameters

  • participants: string[]
  • Optional mediaTypes: Readonly<MediaTypes>

  Returns Promise<{
      code: number;
      whoAccepted?: string;
  }[]>

join

• join(): Promise<void>

• Connects to the conference

  Returns Promise<void>

leave

• leave(errorCode?): Promise<void>

• Leaves the conference

  Parameters

  • Optional errorCode: number

    the rejection cause when an invitation is received and the conference has not been joined.

  Returns Promise<void>

muteRequest

• muteRequest(to, muted?): Promise<void>

• Request a remote participant to mute their audio

  Parameters

  • to: string

    The id of the participant to mute
  • muted: boolean = true

    If true, requests the remote participant to turn off their microphone and if false to turn it on.

  Returns Promise<void>

sendDtmf

• sendDtmf(value): Promise<void>

• Send a DTMF to the conference

  Parameters

  • value: Dtmf

    The DTMF code to send

  Returns Promise<void>

startAttendedTransfer

• startAttendedTransfer(target, mediaTypes?): Promise<Conference>

• Create an attended call transfer towards a user in the system

  Parameters

  • target: string

    user that will be inserted in conference.
  • mediaTypes: Readonly<MediaTypes> = ...

  Returns Promise<Conference>

  a temporal conference with "target" to use for the attended transfer

transfer

• transfer(participant, mediaTypes?): Promise<void>

• Create an unattended call transfer towards a user in the system

  Parameters

  • participant: string
  • mediaTypes: Readonly<MediaTypes> = ...

    the current media types will be used if nothing is specified

  Returns Promise<void>

unhold

• unhold(): Promise<void>

• Stop local hold Republishes all previously published media, subscribes to previously subscribed media and notifies new status to other participants.

  Returns Promise<void>

Static create

• create(manager, room, mediaConstraints, ownId): Conference

• Parameters

  • manager: ConferenceManager
  • room: Conference
  • mediaConstraints: MediaStreamConstraints
  • ownId: string

  Returns Conference