ConferenceManager
This class provides access to every conference related feature This class must never be directly instantiated, instances of this class can be obtained using Session#getConferenceManager.
Events
conferenceInvitation
Conference - Emitted every time an invitation to a conference room is received
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
ownId: * |
|
public |
|
Method Summary
Public Methods | ||
public |
async createConference(options: *): * Creates a new conference room |
|
public |
async getConferenceByUri(uri: *): * this method was deprecated. Use "getMeetingConference" or "getQuickConference" instead
Get a Conference by uri |
|
public |
async getConferenceForRoom(room: *): * |
|
public |
getConferenceLog(): * Returns a ConferenceLog reference |
|
public |
async getCurrentInvitations(): * Asks the server for the current invitations available to the user |
|
public |
Returns current media constraints used by default when creating conferences |
|
public |
async getMeetingConference(meetingId: *, password: *): * Get a conference for a meeting |
|
public |
async getQuickConference(quickConferenceId: *): * Gets a quick conference |
|
public |
async onIncomingConference(room: *, mediaTypes: *) |
|
public |
setDefaultMediaConstraints(defaultMediaConstraints: MediaStreamConstraints) Sets the constraints that will be used as initial value for media requests when initializing conferences. |
Public Constructors
public constructor() source
Public Members
public conferenceLog: * source
public conferenceLogService: * source
public conferenceService: * source
public defaultMediaConstraints: * source
public kManageService: * source
public ownId: * source
public permissionManager: * source
Public Methods
public async createConference(options: *): * source
Creates a new conference room
Params:
Name | Type | Attribute | Description |
options | * | ||
options.recording | * | boolean indicating whether the conference is going to be recorded or not. This applies only if the user has PermissionManager.canSetRecordOption permission |
Return:
* |
public async getConferenceByUri(uri: *): * source
Get a Conference by uri
Params:
Name | Type | Attribute | Description |
uri | * |
Return:
* |
public async getConferenceForRoom(room: *): * source
Params:
Name | Type | Attribute | Description |
room | * |
Return:
* |
public async getCurrentInvitations(): * source
Asks the server for the current invitations available to the user
Return:
* |
public getDefaultMediaConstraints(): * source
Returns current media constraints used by default when creating conferences
Return:
* |
public async getMeetingConference(meetingId: *, password: *): * source
Get a conference for a meeting
Params:
Name | Type | Attribute | Description |
meetingId | * | ||
password | * |
Return:
* | fulfilled when the response is received |
Throw:
thrown when trying to access the conference before scheduled time |
|
thrown when the conference is protected by password and the password is not recived or is not valid. |
public async getQuickConference(quickConferenceId: *): * source
Gets a quick conference
Params:
Name | Type | Attribute | Description |
quickConferenceId | * |
Return:
* | fulfilled when the response is received |
public async onIncomingConference(room: *, mediaTypes: *) source
Params:
Name | Type | Attribute | Description |
room | * | ||
mediaTypes | * |
public setDefaultMediaConstraints(defaultMediaConstraints: MediaStreamConstraints) source
Sets the constraints that will be used as initial value for media requests when initializing conferences. For more information about valid values see https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamConstraints
Params:
Name | Type | Attribute | Description |
defaultMediaConstraints | MediaStreamConstraints |
Example:
conferenceManager.setDefaultMediaConstraints({
audio: {
autoGainControl: true,
echoCancellation: true,
noiseSuppression: true,
},
video: true,
});