SpotlightCallFeature interface

Spotlight-samtalsfunktion.

Extends

Egenskaper

maxParticipantsToSpotlight

Returnerar det maximala antalet deltagare som kan lyftas fram

Ärvda egenskaper

name

Funktionsnamnet.

Metoder

getSpotlightedParticipants()
off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Prenumerationsfunktion för SpotlightUpdated-händelse

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Prenumerationsfunktion för SpotlightUpdated-händelse

startSpotlight(CommunicationIdentifier[])
stopAllSpotlight()

Stoppar Spotlighting för alla deltagare.

stopSpotlight(CommunicationIdentifier[])

Ärvda metoder

dispose()

Egenskapsinformation

maxParticipantsToSpotlight

Returnerar det maximala antalet deltagare som kan lyftas fram

maxParticipantsToSpotlight: number

Egenskapsvärde

number

Information om ärvda egenskaper

name

Funktionsnamnet.

name: string

Egenskapsvärde

string

ärvd frånCallFeature.name

Metodinformation

getSpotlightedParticipants()

function getSpotlightedParticipants(): SpotlightedParticipant[]

Returer

Returnerar en lista över alla deltagare som för närvarande är spotlight-ade

off("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Prenumerationsfunktion för SpotlightUpdated-händelse

function off(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

Parametrar

event

"spotlightChanged"

händelsenamn

listener

CollectionUpdatedEvent<SpotlightedParticipant>

återanropsfunktion som användes för att prenumerera på den här händelsen

on("spotlightChanged", CollectionUpdatedEvent<SpotlightedParticipant>)

Prenumerationsfunktion för SpotlightUpdated-händelse

function on(event: "spotlightChanged", listener: CollectionUpdatedEvent<SpotlightedParticipant>)

Parametrar

event

"spotlightChanged"

händelsenamn

listener

CollectionUpdatedEvent<SpotlightedParticipant>

återanropsfunktion som användes för att prenumerera på den här händelsen

startSpotlight(CommunicationIdentifier[])

function startSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

Parametrar

participants

CommunicationIdentifier[]

startar Spotlight för lokala och fjärranslutna deltagare när deltagarmatrisen inte skickas, åtgärden utförs på den lokala deltagaren

Returer

Promise<void>

Ett löfte som representerar slutförandet av åtgärden startParticipantSpotlight. En SpotlightUpdated-händelse genereras när startParticipantSpotlight har startats.

stopAllSpotlight()

Stoppar Spotlighting för alla deltagare.

function stopAllSpotlight(): Promise<void>

Returer

Promise<void>

Ett löfte som representerar slutförandet av åtgärden stopAllSpotlight. En SpotlightUpdated-händelse genereras när stopAllSpotlight har stoppats.

stopSpotlight(CommunicationIdentifier[])

function stopSpotlight(participants?: CommunicationIdentifier[]): Promise<void>

Parametrar

participants

CommunicationIdentifier[]

stoppar Spotlight för lokala och fjärranslutna deltagare när deltagarmatrisen inte skickas, åtgärden utförs på den lokala deltagaren

Returer

Promise<void>

Ett löfte som representerar slutförandet av stopParticipantSpotlight-åtgärden. En SpotlightUpdated-händelse genereras när stopParticipantSpotlight har stoppats.

Ärvd metodinformation

dispose()

function dispose()

ärvs frånCallFeature.dispose