Conference
Represents audio or video conference. Add the following line to your scenario code to use the class:
require(Modules.Conference);
Methods
add
add(options: ):
Create new endpoint and add it to the specified conference. Important! You can only use this function for a conference with the “video conference” option checked in the rule. Otherwise, you'll receive the ConferenceEvents.ConferenceError event with code 102. The maximum number of endpoints is 100.
Parameters
options:
Returns
type:
addEventListener
addEventListener(event: , callback: Function
): void
Adds handler for specific event generated by Conference. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler will be called.
Parameters
event:
callback:
Function
Returns
type:
void
get
get(id: string
):
Get endpoint by the id
Parameters
id:
string
endpoint id
Returns
type:
removeEventListener
removeEventListener(event: , callback: Function
): any
Removes handler for specific event generated by Conference
Parameters
event:
callback:
Function
Optional
Returns
type:
any
sendMediaTo
sendMediaTo(mediaUnit: , optional: ): void
Start sending media (voice and video) from this conference to media unit specified in targetCall.
Parameters
mediaUnit:
media unit that will receive media
optional:
Optional
Returns
type:
void
setMaxEndpointBitrate
setMaxEndpointBitrate(bitrate: number
): void
Parameters
bitrate:
number
Returns
type:
void
stop
stop(): void
Stop the conference. Triggers the ConferenceEvents.Stopped event.
Returns
type:
void
stopMediaTo
stopMediaTo(mediaUnit: ): void
Stop sending media (voice and video) from this conference to media unit specified in targetMediaUnit.
Parameters
mediaUnit:
media unit that will not receive media from this conference anymore.
Returns
type:
void