Class Conferences

This class implements a Conferences module that provides access to conference management methods.

Events

incomingConference: Fired when an invitation to a conference is received.

Hierarchy

Conferences

Constructors

constructor

new Conferences(dependencies?: Dependencies): Conferences
Parameters
- dependencies: Dependencies = {}
Returns Conferences
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:39

Properties

`Private` conferences

conferences: Record<string, Conference> = {}

Conference collection, indexed by id

`Private` dependencies

dependencies: Dependencies = {}

emitter

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

`Private` session

session: any = null

Server client

Methods

`Private` _addConferenceToCollection

_addConferenceToCollection(conference: Conference): void
Add a conference to collection.
Parameters
- conference: Conference
  
  conference to add.
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:202

`Private` _createConferenceForRoom

_createConferenceForRoom(room: any): Conference
Parameters
- room: any
Returns Conference
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:190

`Private` _createNewConference

_createNewConference(): Conference
Returns Conference
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:186

`Private` _removeConferenceFromCollection

_removeConferenceFromCollection(id: string): void
Removes a conference from collection
Parameters
- id: string
  
  conference identifier
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:223

create

create(recording: boolean): Promise<Conference>
Creates a new conference with given identifier.

Returns
created conference on success.
Parameters
- recording: boolean
  
  indicating whether the conference is going to be recorded or not
Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:122

fetch

fetch(): Conference[]
Get any conference where user is included as participant.

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

get

get(conferenceId: string): Conference
Get an existing conference by conference ID.
Parameters
- conferenceId: string
  
  conference ID.
Returns Conference
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:113

getCurrentInvitations

getCurrentInvitations(): Promise<Conference[]>
Retrieves current invitations

Returns
A resolved promise with an array of Conferences if succeeds

Returns Promise<Conference[]>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:135

getMeetingConference

getMeetingConference(meetingId: string, password?: string): Promise<Conference>
Returns a meeting conference

Returns
conference for the meeting
Parameters
- meetingId: string
- Optional password: string
Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:166

getQuickConference

getQuickConference(quickConferenceId: string): Promise<Conference>
Returns a quick conference

Returns
conference for the meeting
Parameters
- quickConferenceId: string
Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:177

getRoomByUri

getRoomByUri(uri: string): Promise<Conference>
Parameters
- uri: string
Returns Promise<Conference>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:155

`Private` handleIncomingInvite

handleIncomingInvite(data: any): Conference
Parameters
- data: any
Returns Conference
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:269

init

init(session: any): Promise<void>
Initialize conferences module. Get any room where user participates from server and create Conference elements with them. It also listens for new rooms notified by server.
Parameters
- session: any
  
  associated signaling session.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:53

`Private` onIncomingInvite

onIncomingInvite(data: any): void
Event listener called when an invite is received
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:248

`Private` onRoomUpdated

onRoomUpdated(data: any): void
Event listener called when a room update message is received
Parameters
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:235

resume

resume(): Promise<void>
Resume conferences:
- resume any managed conference.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:96

suspend

suspend(): Promise<void>
Suspend conferences:
- cancel any pending invitation request sent.
- update internally any received invitation request to canceled.
- suspend any managed conference.
Returns Promise<void>
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:86

uninit

uninit(): void
Deinitialize conferences module. Stops listening for new rooms messages from server.

Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:69

`Private` updateWithServerData

updateWithServerData(conference: Conference, data: any): void
Parameters
- conference: Conference
- data: any
Returns void
- Defined in src/wac-proxy/stacks/Janus/Conferences.ts:253

Class Conferences

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dependencies: Dependencies = {}

Returns Conferences

Properties

Private conferences

Private dependencies

emitter

Private session

Methods

Private _addConferenceToCollection

Parameters

conference: Conference

Returns void

Private _createConferenceForRoom

Parameters

room: any

Returns Conference

Private _createNewConference

Returns Conference

Private _removeConferenceFromCollection

Parameters

id: string

Returns void

create

Returns

Parameters

recording: boolean

Returns Promise<Conference>

fetch

Returns Conference[]

get

Parameters

conferenceId: string

Returns Conference

getCurrentInvitations

Returns

Returns Promise<Conference[]>

getMeetingConference

Returns

Parameters

meetingId: string

Optional password: string

Returns Promise<Conference>

getQuickConference

Returns

Parameters

quickConferenceId: string

Returns Promise<Conference>

getRoomByUri

Parameters

uri: string

Returns Promise<Conference>

Private handleIncomingInvite

Parameters

data: any

Returns Conference

init

Parameters

session: any

Returns Promise<void>

Private onIncomingInvite

Parameters

data: any

Returns void

Private onRoomUpdated

Parameters

data: any

Returns void

resume

Returns Promise<void>

suspend

Returns Promise<void>

`Private` conferences

`Private` dependencies

`Private` session

`Private` _addConferenceToCollection

`Private` _createConferenceForRoom

`Private` _createNewConference

`Private` _removeConferenceFromCollection

`Optional` password: string

`Private` handleIncomingInvite

`Private` onIncomingInvite

`Private` onRoomUpdated

`Private` updateWithServerData