Class Conference

Fires

UPDATED_CONFERENCE_EVENT

Fires

DESTROYED_CONFERENCE_EVENT

Fires

EXPEL_CONFERENCE_EVENT

Fires

LOCAL_STREAM_CHANGED

Fires

REMOTE_STREAM_CHANGED

Fires

TRANSFERING_CALL

Hierarchy

EventEmitter2
- Conference

Index

Constructors

constructor

new Conference(dependencies?: Dependencies): Conference
Parameters
- dependencies: Dependencies = {}
Returns Conference
Overrides EventEmitter2.constructor
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:240

Properties

`Private` _ice

_ice: any[] = []

Conference ice servers

`Private` _id

_id: string = ''

Room identifier

`Private` _invite

_invite: null | Invite = null

Invitation when user doesn't joined the conference.

`Private` _left

_left: boolean = false

True if leave method was called

`Private` _mediaUpdateInProgress

_mediaUpdateInProgress: boolean = false

`Private` _participants

_participants: string[] = []

User identifiers that participate on a conference.

`Private` _pendingInvites

_pendingInvites: {} = {}

Contains a list of pending invitations (still not accepted/rejected by remote peer) transaction identifiers. Used to cancel a previous invitation and determine if an user has been invited.

Type declaration

`Private` _record

_record: boolean = false

Indicates if conference is being recorded

`Private` _room

_room: any = null

Janus client

`Private` _server

_server: string = ''

Conference server

`Private` _session

_session: any = null

Server client

`Private` _token

_token: string = ''

Conference access token

`Private` _uninitializingRoom

_uninitializingRoom: undefined | Promise<void>

`Private` dependencies

dependencies: Dependencies = {}

`Private` parallelSipExtension

parallelSipExtension: null = null

`Private` sipUri

sipUri: null = null

`Private` transferingCall

transferingCall: boolean = false

Accessors

id

get id(): string
Conference identifier

Returns string
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:265

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
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:280

invited

get invited(): boolean
Indicate if invited

Returns boolean
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:272

isOnHold

get isOnHold(): boolean
Check if conference is on hold state.

Returns boolean
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:376

joined

get joined(): boolean
Indicate if joined

Returns boolean
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:287

localStreams

get localStreams(): ConferenceMediaStream[]
Current local streams.

Returns ConferenceMediaStream[]
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:332

participants

get participants(): string[]
Conference participants, expressed as a list of current user identifiers

Returns string[]
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:325

recording

get recording(): boolean
True if conference is being recorded

Returns boolean
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:619

remoteStreams

get remoteStreams(): ConferenceMediaStream[]
Current remote streams.

Returns ConferenceMediaStream[]
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:342

session

set session(session: any): void
Server session.
Parameters
- session: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:294

streams

get streams(): ConferenceMediaStream[]
Current conference streams.

Returns ConferenceMediaStream[]
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:352

Methods

acceptCallTransfer

acceptCallTransfer(callTransferID: string): Promise<void>
Accept inviting to other participant to make an unattended call transfer
Parameters
- callTransferID: string
  
  identifier of a call transfer
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:653

cancelInvitation

cancelInvitation(participant: string): void
Cancel an invite
Parameters
- participant: string
  
  user name to decline.
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:518

cancelPendingInvite

cancelPendingInvite(participant: string): void
Parameters
- participant: string
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:526

createJanusRoom

createJanusRoom(): any
Returns any
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:658

expelParticipant

expelParticipant(participant: string): Promise<void>
Removes a participant from this conference.

Returns
resolved when remote user leaves conference.
Parameters
- participant: string
  
  user name to remove.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:543

getParticipants

getParticipants(): unknown
Returns unknown
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:686

hold

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

Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:360

`Private` initRoom

initRoom(): Promise<void>
Initialize Janus client after joining a conference.

Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:693

inviteMany

inviteMany(participants: {
    inviteId: string;
    to: string;
}[], mediaTypes: MediaTypes, context?: Record<string, string>): Promise<{
    code: number;
    whoAccepted?: string;
}[]>
Invite participants to this conference.

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

Returns
A promise with an array of objects with two properties: SIP code and whoAccepted the invite

Property
SIP code of the response

Property
User id of the participant that accepted the invite
Parameters
- participants: {
  inviteId: string;
  to: string;
  }[]
  
  participants that will be invited.
- mediaTypes: MediaTypes
  
  the mediatypes requested to the new participant.
- Optional context: Record<string, string>
  
  arbitrary context that can be sent to invites
Returns Promise<{
code: number;
whoAccepted?: string;
}[]>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:480

inviteParticipant

inviteParticipant(participant: string, mediatypes: MediaTypes, requestId?: string, context?: Record<string, string>): Promise<{
code: number;
whoAccepted?: string;
}>
Add participant to this conference.

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

Returns
resolved with a boolean value that indicates if remote accepts the invitation.
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;
}>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:425

join

join(mediatypes: MediaTypes): Promise<void>
Join this conference and start sending local media defined by mediatype parameter.
Parameters
- mediatypes: MediaTypes
  
  local media used after joining the conference.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:403

leave

leave(errorCode: number): Promise<Conference>
Leaves this conference or rejects a previous invitation.

Throws
when already joined or a previous invitation was not received.

Returns
resolved on success with self reference.
Parameters
- errorCode: number
  
  the rejection cause when an invitation is received and the conference has not been joined.
Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:555

`Private` onInviteCancel

onInviteCancel(evt: any): void
Callback called when an invitation is canceled
Parameters
- evt: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:792

`Private` onParticipantAdded

onParticipantAdded(data: any): void
Callback called when a new participant joins the room
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:853

`Private` onParticipantHold

onParticipantHold(data: any): void
Callback called when a remote participant does a hold
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:867

`Private` onParticipantRemoved

onParticipantRemoved(data: any): void
Callaback called when a participant leaves the room
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:860

`Private` onParticipantUnhold

onParticipantUnhold(data: any): void
Callback called when a remote participant stops a hold
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:874

`Private` onRoomDestroyed

onRoomDestroyed(): Promise<void>
Callback called when a destroyed room event is received.

Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:763

`Private` onRoomUpdated

onRoomUpdated(data: any): void
Callback called when a room update event is received.
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:784

`Private` onSpeakerChanged

onSpeakerChanged(data: any): void
Callback called when change the participants who are speaking
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:881

`Private` onStreamAdded

onStreamAdded(stream: ConferenceMediaStream): void
Callback called when a ConferenceMediaStream is added.
Parameters
- stream: ConferenceMediaStream
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:802

`Private` onStreamChanged

onStreamChanged(stream: ConferenceMediaStream): void
Callback called when a ConferenceMediaStream has changed.
Parameters
- stream: ConferenceMediaStream
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:824

`Private` onStreamRemoved

onStreamRemoved(stream: ConferenceMediaStream): void
Callback called when a ConferenceMediaStream is removed.
Parameters
- stream: ConferenceMediaStream
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:813

`Private` onTransferingCallToPeer

onTransferingCallToPeer(data: any): void
Callback called when an invitation is canceled
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:845

`Private` removeRoomListeners

removeRoomListeners(): void
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:712

resume

resume(): Promise<void>
Resume conference

Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:395

sendDtmf

sendDtmf(value: Dtmf): unknown
Parameters
- value: Dtmf
Returns unknown
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:679

startRecording

startRecording(): Promise<Conference>
Starts recording this conference

Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:626

stopRecording

stopRecording(): Promise<Conference>
Stops conference recording

Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:634

suspend

suspend(): Promise<void>
Suspend conference:
- cancel any pending invitation sent.
- decline invitation if we was invited to this conference.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:385

unattendedCallTransfer

unattendedCallTransfer(participant: string, mediatypes: 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>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:644

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/wac-proxy/stacks/Janus/Conference.ts:369

`Private` uninitRoom

uninitRoom(): Promise<void>
Deinitialize Janus client after leaving a conference.

Returns
resolved on success

Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:571

`Private` uninitRoomIfExists

uninitRoomIfExists(): Promise<void>
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:580

update

update(mediatypes: MediaTypes): Promise<void>
Update local media types.
Parameters
- mediatypes: MediaTypes
  
  required mediatypes.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:600

updateWithServerData

updateWithServerData(data: any): Conference
Updates instance properties with data returned by a signaling server
Parameters
- data: any
  
  server data
Returns Conference
- Defined in src/wac-proxy/stacks/Janus/Conference.ts:726

Class Conference

Fires

Fires

Fires

Fires

Fires

Fires

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

dependencies: Dependencies = {}

Returns Conference

Properties

Private _ice

Private _id

Private _invite

Private _left

Private _mediaUpdateInProgress

Private _participants

Private _pendingInvites

Type declaration

Private _record

Private _room

Private _server

Private _session

Private _token

Private _uninitializingRoom

Private dependencies

Private parallelSipExtension

Private sipUri

Private transferingCall

Accessors

id

Returns string

invite

Returns null | Invite

invited

Returns boolean

isOnHold

Returns boolean

joined

Returns boolean

localStreams

Returns ConferenceMediaStream[]

participants

Returns string[]

recording

Returns boolean

remoteStreams

Returns ConferenceMediaStream[]

session

Parameters

session: any

Returns void

streams

Returns ConferenceMediaStream[]

Methods

acceptCallTransfer

Parameters

callTransferID: string

Returns Promise<void>

cancelInvitation

Parameters

participant: string

Returns void

cancelPendingInvite

Parameters

participant: string

Returns void

createJanusRoom

Returns any

expelParticipant

Returns

Parameters

`Private` _ice

`Private` _id

`Private` _invite

`Private` _left

`Private` _mediaUpdateInProgress

`Private` _participants

`Private` _pendingInvites

`Private` _record

`Private` _room

`Private` _server

`Private` _session

`Private` _token

`Private` _uninitializingRoom

`Private` dependencies

`Private` parallelSipExtension

`Private` sipUri

`Private` transferingCall

`Private` initRoom

participants: {
inviteId: string;
to: string;
}[]

`Optional` context: Record<string, string>

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

`Optional` requestId: string

`Optional` context: Record<string, string>

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

`Private` onInviteCancel

`Private` onParticipantAdded

`Private` onParticipantHold

`Private` onParticipantRemoved

`Private` onParticipantUnhold

`Private` onRoomDestroyed

`Private` onRoomUpdated

`Private` onSpeakerChanged

`Private` onStreamAdded