Class Conference

constructor

• new Conference(dependencies?): Conference

• Parameters

  • dependencies: Dependencies = {}

  Returns Conference

callTransfer$

destroyed$

localStreamAdded$

localStreamRemoved$

mediaManager

muteChange$

muteRequest$

participant$

remoteStreamAdded$

remoteStreamRemoved$

speakerChange$

id

• get id(): string

• Conference identifier

  Returns string

invite

• get invite(): null | Invite

• Returns an object with the invitation (with the properties "id" an "from") Needed to know who is inviting us in anonymous rooms

  Returns null | Invite

invited

• get invited(): boolean

• Indicate if invited

  Returns boolean

isOnHold

• get isOnHold(): boolean

• Check if conference is on hold state.

  Returns boolean

joined

• get joined(): boolean

• Indicate if joined

  Returns boolean

localStreams

• get localStreams(): ConferenceMediaStream[]

• Current local streams.

  Returns ConferenceMediaStream[]

participants

• get participants(): string[]

• Conference participants, expressed as a list of current user identifiers

  Returns string[]

recording

• get recording(): boolean

• True if conference is being recorded

  Returns boolean

remoteStreams

• get remoteStreams(): ConferenceMediaStream[]

• Current remote streams.

  Returns ConferenceMediaStream[]

session

• set session(session): void

• Server session.

  Parameters

  • session: null | Session

  Returns void

streams

• get streams(): ConferenceMediaStream[]

• Current conference streams.

  Returns ConferenceMediaStream[]

acceptCallTransfer

• acceptCallTransfer(callTransferID): Promise<void>

• Accept inviting to other participant to make an unattended call transfer

  Parameters

  • callTransferID: string

    identifier of a call transfer

  Returns Promise<void>

cancelAttendedTransfer

• cancelAttendedTransfer(target): Promise<AttendedTransferResponseData>

• Cancels the in progress attended call transfer.

  Parameters

  • target: string

    who must be inserted in conference.

  Returns Promise<AttendedTransferResponseData>

cancelInvitation

• cancelInvitation(participant): void

• Cancel an invite

  Parameters

  • participant: string

    user name to decline.

  Returns void

cancelPendingInvite

• cancelPendingInvite(participant): void

• Parameters

  • participant: string

  Returns void

createAttendedCallTransfer

• createAttendedCallTransfer(target, transferee): Promise<AttendedTransferResponseData>

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

  Parameters

  • target: string

    user that will be inserted in conference.
  • transferee: string

    user who will stay in the transferred conference

  Returns Promise<AttendedTransferResponseData>

executeAttendedTransfer

• executeAttendedTransfer(target, roomId): Promise<AttendedTransferResponseData>

• Executes the in progress attended call transfer.

  Parameters

  • target: string

    who must be inserted in conference.
  • roomId: string

  Returns Promise<AttendedTransferResponseData>

expelParticipant

• expelParticipant(participant): Promise<void>

• Removes a participant from this conference.

  Parameters

  • participant: string

    user name to remove.

  Returns Promise<void>

  resolved when remote user leaves conference.

getParticipants

• getParticipants(): unknown

• Returns unknown

hold

• hold(): Promise<void>

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

  Returns Promise<void>

inviteParticipant

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

• Add participant to this conference.

  Parameters

  • participant: string

    user name to add.
  • mediatypes: MediaTypes

    the mediatypes requested to the new participant.
  • Optional requestId: string

    the ID of the request that generated this invitation.
  • Optional context: Record<string, string>

    arbitrary context that can be sent to invites

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

  resolved with a boolean value that indicates if remote accepts the invitation.

  Throws

  if participant is already present on conference or a pending invitation exists.

join

• join(mediatypes): Promise<void>

• Join this conference and start sending local media defined by mediatype parameter.

  Parameters

  • mediatypes: MediaStreamConstraints

    local media used after joining the conference.

  Returns Promise<void>

leave

• leave(errorCode?): Promise<Conference>

• Leaves this conference or rejects a previous invitation.

  Parameters

  • Optional errorCode: number

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

  Returns Promise<Conference>

  resolved on success with self reference.

  Throws

  when already joined or a previous invitation was not received.

mute

• mute(muted): Promise<void>

• Parameters

  • muted: boolean

  Returns Promise<void>

muteRequest

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

• Parameters

  • to: string
  • muted: boolean

  Returns Promise<void>

resume

• resume(): Promise<void>

• Resume conference

  Returns Promise<void>

sendDtmf

• sendDtmf(value): Promise<unknown>

• Parameters

  • value: Dtmf

  Returns Promise<unknown>

startRecording

• startRecording(): Promise<Conference>

• Starts recording this conference

  Returns Promise<Conference>

stopRecording

• stopRecording(): Promise<Conference>

• Stops conference recording

  Returns Promise<Conference>

suspend

• suspend(): Promise<void>

• Suspend conference:

  • cancel any pending invitation sent.
  • decline invitation if we was invited to this conference.

  Returns Promise<void>

unattendedCallTransfer

• unattendedCallTransfer(participant, mediatypes): Promise<void>

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

  Parameters

  • participant: string

    user name to call.
  • mediatypes: MediaTypes

    the mediatypes requested to the new participant.

  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>

update

• update(mediatypes): Promise<void>

• Update local media types.

  Parameters

  • mediatypes: MediaStreamConstraints | {
        screen: boolean;
    }

    required mediatypes.

  Returns Promise<void>

updateWithServerData

• updateWithServerData(data): Conference

• Updates instance properties with data returned by a signaling server

  Parameters

  • data: any

    server data

  Returns Conference