Conference - Documentation

Constructor

new Conference(name, uuid, endpoint, optsopt)

Source:

conference.js, line 32

Parameters:

Name	Type	Attributes	Description
`name`	`String`		conference name
`uuid`	`String`		conference uuid
`endpoint`	`Endpoint`		endpoint that provides the control connection for the conference
`opts`	`Conference~createOptions`	<optional>	conference-level configuration options

Members

locked :Boolean

true if conference is locked

Source:

conference.js, line 70

Type:

Boolean

maxMembers :Number

max number of members allowed (-1 means no limit)

Source:

conference.js, line 88

Type:

Number

memberId :Number

member ID of the conference control leg

Source:

conference.js, line 76

Type:

Number

name :string

conference name

Source:

conference.js, line 46

Type:

string

participants :Map

current participants in the conference, keyed by member ID

Source:

conference.js, line 82

Type:

Map

recordFile :String

file that conference is currently being recorded to

Source:

conference.js, line 58

Type:

String

state :Number

conference state

Source:

conference.js, line 64

Type:

Number

uuid :string

conference unique id

Source:

conference.js, line 52

Type:

string

Methods

agc(level, callbackopt) → {Promise|Conference}

adjust the automatic gain control for the conference

Source:

conference.js, line 176

Parameters:

Name	Type	Attributes	Description
`level`	`Number` \| `String`		'on', 'off', or a numeric level
`callback`	`Conference~mediaOperationCallback`	<optional>	callback invoked when operation completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

chkRecord(callbackopt) → {Promise|Conference}

check the status of the conference recording

Source:

conference.js, line 184

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

deaf(callbackopt) → {Promise|Conference}

deaf all the non-moderators in the conference

Source:

conference.js, line 192

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

destroy(callback) → {Promise|Conference}

destroy the conference, releasing all legs

Source:

conference.js, line 117

Parameters:

Name	Type	Description
`callback`	`Conference~operationCallback`	callback invoked when conference has been destroyed

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

get(param, callbackopt) → {Promise|Conference}

get a conference parameter value

Source:

conference.js, line 158

Parameters:

Name	Type	Attributes	Description
`param`	`String`		parameter to retrieve
`callback`	`Conference~mediaOperationCallback`	<optional>	callback invoked when operation completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

getSize() → {Promise}

retrieve the current number of participants in the conference

Source:

conference.js, line 140

Returns:

Type:: Promise

promise that resolves with the count of participants (including control leg)

list(cbopt) → {Promise|Conference}

list members

Source:

conference.js, line 239

Parameters:

Name	Type	Attributes	Description
`cb`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

lock(callbackopt) → {Promise|Conference}

lock the conference

Source:

conference.js, line 223

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

mute(cbopt) → {Promise|Conference}

mute all the non-moderators in the conference

Source:

conference.js, line 208

Parameters:

Name	Type	Attributes	Description
`cb`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

pauseRecording(callbackopt) → {Promise|Conference}

pause the recording

Source:

conference.js, line 283

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

play(file, callbackopt) → {Promise|Conference}

play an audio file or files into the conference

Source:

conference.js, line 383

Parameters:

Name	Type	Attributes	Description
`file`	`string` \| `Array`		file (or array of files) to play
`callback`	`Conference~playOperationCallback`	<optional>	callback invoked when the files have completed playing

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

resumeRecording(callbackopt) → {Promise|Conference}

resume the recording

Source:

conference.js, line 316

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

set(param, value, callbackopt) → {Promise|Conference}

set a conference parameter value

Source:

conference.js, line 167

Parameters:

Name	Type	Attributes	Description
`param`	`String`		parameter to set
`value`	`String`		value
`callback`	`Conference~mediaOperationCallback`	<optional>	callback invoked when operation completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

startRecording(file, callbackopt) → {Promise|Conference}

start recording the conference

Source:

conference.js, line 248

Parameters:

Name	Type	Attributes	Description
`file`	`String`		filepath to record to
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

stopRecording(callbackopt) → {Promise|Conference}

stop the conference recording

Source:

conference.js, line 349

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

undeaf(callbackopt) → {Promise|Conference}

undeaf all the non-moderators in the conference

Source:

conference.js, line 200

Parameters:

Name	Type	Attributes	Description
`callback`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

unlock(cbopt) → {Promise|Conference}

unlock the conference

Source:

conference.js, line 231

Parameters:

Name	Type	Attributes	Description
`cb`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

unmute(cbopt) → {Promise|Conference}

unmute all the non-moderators in the conference

Source:

conference.js, line 215

Parameters:

Name	Type	Attributes	Description
`cb`	`Conference~mediaOperationsCallback`	<optional>	callback invoked when media operations completes

Returns:

Type:: Promise | Conference

returns a Promise if no callback supplied; otherwise a reference to the Conference object

Type Definitions

createOptions

This object describes the options when creating a conference

Properties:

Name	Type	Description
`maxMembers`	`number`	maximum number of members to allow in the conference

Source:

conference.js, line 605

Type:

Object

mediaOperationCallback(err, response)

This callback is invoked whenever any media command has completed

Source:

conference.js, line 587

Parameters:

Name	Type	Description
`err`	`Error`	error returned, if any
`response`	`String`	response to the command

operationCallback(err)

This callback is invoked when a command has completed

Source:

conference.js, line 593

Parameters:

Name	Type	Description
`err`	`Error`	error returned, if any

playbackResults

This object describes the results of a playback into conference operation

Properties:

Name	Type	Description
`seconds`	`number`	total seconds of media played
`milliseconds`	`number`	total milliseconds of media played
`samples`	`number`	total number of samples played

Source:

conference.js, line 610

Type:

Object

playOperationCallback(err, resultsopt)

This callback is invoked when a playback to conference command completes with a play done event of the final file.

Source:

conference.js, line 599

Parameters:

Name	Type	Attributes	Description
`err`	`Error`		error returned, if any
`results`	`Conference~playbackResults`	<optional>	results describing the duration of media played