useActiveParticipantDeprecated
useActiveParticipant
Deprecated
useActiveParticipant(params?) : Object | null
Returns an object for the participant id mentioned in the most recent active-speaker-change event.
useActiveParticipant can also set up an optional callback for the active-speaker-change event.
Params (optional)
| Parameter | Required | Type | Description |
|---|---|---|---|
ignoreLocal | boolean | If true, useActiveParticipant will not return a participant object when the local participant is the active speaker | |
onActiveSpeakerChange | Function | event callback for active-speaker-change event listener |
Return type
| Type | Description |
|---|---|
Object | null | Contains detailed information about the participant, see participant properties. If no participant has unmuted, useActiveParticipant returns null |
Sample code
Related references
- useActiveSpeakerId()
- useLocalParticipant()
- useLocalSessionId()
- useParticipantCounts()
- useParticipantIds()
- useParticipantProperty()
- useParticipant()
- useWaitingParticipants()