LiveKit LogoDocs
Real-timeEgress/IngressCloudReference

useVisualStableUpdate

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The useVisualStableUpdate hook tries to keep visual updates of the TackBundles array to a minimum, while still trying to display important tiles such as speaking participants or screen shares.

Updating works with pagination. For example, if a participant starts speaking on the second page, they will be moved to the first page by replacing the least active/interesting participant on the first page.

Import

import { useVisualStableUpdate } from '@livekit/components-react';

Parameters

#
maxItemsOnPagenumber

#
trackReferencesTrackReferenceOrPlaceholder[]

#
options?UseVisualStableUpdateOptions

Returns

TrackReferenceOrPlaceholder[]

On this page

ImportParametersReturns

Previous

Chevron IconuseTrackToggle
LiveKit Logo

Product

SFU

SDKs

Cloud Dashboard

Cloud Status

GitHub Logo