Class Conference

Provides access to methods for managing outgoing or incoming conferences. Conference objects are obtained calling createConference method or handling the onIncoming event of a connected ConferenceManager instance.

Hierarchy

Conference

Constructors

`Private` constructor

new Conference(room: Conference, mediaConstraints: MediaStreamConstraints, ownId: string): Conference
Parameters
- room: Conference
- mediaConstraints: MediaStreamConstraints
- ownId: string
Returns Conference
- Defined in src/conferences/Conference.ts:175

Properties

commonStream$

commonStream$: Observable<undefined | ManagedStream>

`Private` joinTimestampValue

joinTimestampValue: undefined | number

`Private` localActionsSubject

localActionsSubject: Subject<Action> = ...

`Readonly` localMediaHandler

localMediaHandler: LocalMediaHandler

Allows access to local streams and actions related to changing which local media is shared

localParticipant$

localParticipant$: Observable<undefined | ConferenceParticipant>

`Private` lock

lock: Lock = ...

muteRequest$

muteRequest$: Observable<boolean>

`Private` ownId

ownId: string

`Private` participantsConnectable

participantsConnectable: Connectable<ParticipantsState>

participantsMap$

participantsMap$: Observable<ParticipantsState>

remoteParticipants$

remoteParticipants$: Observable<readonly ConferenceParticipant[]>

`Private` room

room: Conference

status$

status$: Observable<ConferenceStatus>

`Private` statusSubject

statusSubject: BehaviorSubject<ConferenceStatus> = ...

`Private` subscription

subscription: Subscription = ...

Accessors

id

get id(): string
Returns the ID of the conference

Returns string
- Defined in src/conferences/Conference.ts:222

invite

get invite(): undefined | ConferenceInvite
Returns the invitation to the conference if the participant was invited.

Returns undefined | ConferenceInvite
- Defined in src/conferences/Conference.ts:250

isRecorded

get isRecorded(): boolean
Indicates if the conference is being recorded

Returns boolean
- Defined in src/conferences/Conference.ts:229

joinTimestamp

get joinTimestamp(): undefined | number
The timestamp when the join to this conference was completed

Returns undefined | number
- Defined in src/conferences/Conference.ts:243

status

get status(): ConferenceStatus
Returns the current status of the conference

Returns ConferenceStatus
- Defined in src/conferences/Conference.ts:236

Methods

`Private` bindEventHandlers

bindEventHandlers(): void
Returns void
- Defined in src/conferences/Conference.ts:453

callVoiceMail

callVoiceMail(mediaTypes?: 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;
}>
- Defined in src/conferences/Conference.ts:360

`Private` cancelOutgoingInvitations

cancelOutgoingInvitations(): Promise<void>
Returns Promise<void>
- Defined in src/conferences/Conference.ts:489

expelParticipant

expelParticipant(userId: string, session?: string): Promise<void>
Expels a participant from this conference
Parameters
- userId: string
- Optional session: string
Returns Promise<void>
- Defined in src/conferences/Conference.ts:335

expelParticipants

expelParticipants(participants: string[]): Promise<void>
Expels a list of participant from this conference
Parameters
- participants: string[]
Returns Promise<void>
- Defined in src/conferences/Conference.ts:352

`Private` getActions

getActions(): Observable<Action>
Returns Observable<Action>
- Defined in src/conferences/Conference.ts:440

hold

hold(): Promise<void>
Local hold Stop publishing and subscribing to the media in the conference

Returns Promise<void>
- Defined in src/conferences/Conference.ts:394

inviteParticipant

inviteParticipant(participant: string, mediaTypes?: Readonly<MediaTypes>, context?: Record<string, string>): Promise<{
code: number;
whoAccepted?: string;
}>
Invites a new participant to this conference

Returns
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).
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;
}>
- Defined in src/conferences/Conference.ts:291

inviteParticipants

inviteParticipants(participants: string[], mediaTypes?: Readonly<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;
}[]>
- Defined in src/conferences/Conference.ts:328

join

join(): Promise<void>
Connects to the conference

Returns Promise<void>
- Defined in src/conferences/Conference.ts:266

leave

leave(errorCode?: number): 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>
- Defined in src/conferences/Conference.ts:369

muteRequest

muteRequest(to: string, muted?: boolean): 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>
- Defined in src/conferences/Conference.ts:436

sendDtmf

sendDtmf(value: Dtmf): Promise<void>
Send a DTMF to the conference
Parameters
- value: Dtmf
  
  The DTMF code to send
Returns Promise<void>
- Defined in src/conferences/Conference.ts:423

`Private` setStatus

setStatus(status: ConferenceStatus): void
Parameters
- status: ConferenceStatus
Returns void
- Defined in src/conferences/Conference.ts:477

transfer

transfer(participant: string, mediaTypes?: Readonly<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>
- Defined in src/conferences/Conference.ts:415

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>
- Defined in src/conferences/Conference.ts:406

`Static` create

create(room: Conference, mediaConstraints: MediaStreamConstraints, ownId: string): Conference
Parameters
- room: Conference
- mediaConstraints: MediaStreamConstraints
- ownId: string
Returns Conference
- Defined in src/conferences/Conference.ts:215

Class Conference

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

room: Conference

mediaConstraints: MediaStreamConstraints

ownId: string

Returns Conference

Properties

commonStream$

Private joinTimestampValue

Private localActionsSubject

Readonly localMediaHandler

localParticipant$

Private lock

muteRequest$

Private ownId

Private participantsConnectable

participantsMap$

remoteParticipants$

Private room

status$

Private statusSubject

Private subscription

Accessors

id

Returns string

invite

Returns undefined | ConferenceInvite

isRecorded

Returns boolean

joinTimestamp

Returns undefined | number

status

Returns ConferenceStatus

Methods

Private bindEventHandlers

Returns void

callVoiceMail

Parameters

Optional mediaTypes: MediaTypes

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

Private cancelOutgoingInvitations

Returns Promise<void>

expelParticipant

Parameters

userId: string

Optional session: string

Returns Promise<void>

expelParticipants

Parameters

participants: string[]

Returns Promise<void>

Private getActions

Returns Observable<Action>

hold

Returns Promise<void>

inviteParticipant

Returns

Parameters

participant: string

Optional mediaTypes: Readonly<MediaTypes>

context: Record<string, string> = {}

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

inviteParticipants

Parameters

participants: string[]

Optional mediaTypes: Readonly<MediaTypes>

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

join

Returns Promise<void>

leave

Parameters

Optional errorCode: number

`Private` constructor

`Private` joinTimestampValue

`Private` localActionsSubject

`Readonly` localMediaHandler

`Private` lock

`Private` ownId

`Private` participantsConnectable

`Private` room

`Private` statusSubject

`Private` subscription

`Private` bindEventHandlers

`Optional` mediaTypes: MediaTypes

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

`Private` cancelOutgoingInvitations

`Optional` session: string

`Private` getActions

`Optional` mediaTypes: Readonly<MediaTypes>

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

`Optional` mediaTypes: Readonly<MediaTypes>

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

`Optional` errorCode: number

`Private` setStatus

`Static` create