SpotlightCallFeatureState interface

Package:

@azure/communication-react

State only version of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature>

Properties

localParticipantSpotlight	Local participant spotlight
maxParticipantsToSpotlight	Proxy of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature.maxParticipantsToSpotlight>.
spotlightedParticipants	Ordered array of spotlighted participants in call

Property Details

localParticipantSpotlight

Local participant spotlight

localParticipantSpotlight?: SpotlightState

Property Value

SpotlightState

maxParticipantsToSpotlight

Proxy of <xref:%40azure%2Fcommunication-calling%23SpotlightCallFeature.maxParticipantsToSpotlight>.

maxParticipantsToSpotlight: number

Property Value

number

spotlightedParticipants

Ordered array of spotlighted participants in call

spotlightedParticipants: SpotlightedParticipant[]

Property Value

SpotlightedParticipant[]