Conference

Methods

add

Creates a new Endpoint instance and adds it to the specified conference. IMPORTANT! You can only use this function for a conference with the “video conference” option checked in the routing rule. Otherwise, you receive the ConferenceEvents.ConferenceError event with code 102. The maximum number of endpoints is 100.

1
add(parameters: EndpointParameters): Endpoint

Parameters

addEventListener

Adds a handler for the specified ConferenceEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: ConferenceEvents | T, callback: (event: _ConferenceEvents[T]) => any): void

Parameters

get

Gets the endpoint by the id.

1
get(id: string): Endpoint

Parameters

getList

Gets the endpoint list for current conference.

1
getList(): Endpoint[]

id

Returns the conference’s id.

1
id(): string

removeEventListener

Removes a handler for the specified ConferenceEvents event.

1
removeEventListener(event: ConferenceEvents | T, callback?: (event: _ConferenceEvents[T]) => any): void

Parameters

sendMediaTo

Starts sending media (voice and video) from the conference to the media unit.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

stop

Stops the conference. Triggers the ConferenceEvents.Stopped event.

1
stop(): void

stopMediaTo

Stops sending media (voice and video) from the conference to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters