livekit-compose-components/io.livekit.android.compose.state/rememberParticipantTrackReferences

rememberParticipantTrackReferences

@Composable
fun rememberParticipantTrackReferences(sources: List<Track.Source>, participantIdentity: Participant.Identity, passedRoom: Room? = null, usePlaceholders: Set<Track.Source> = emptySet(), onlySubscribed: Boolean = true): List<TrackReference>

Returns an array of TrackReferences for a participant depending the sources provided.

Parameters

sources

The sources of the tracks to provide. Defaults to camera and screen share tracks.

participantIdentity

The identity of the participant.

usePlaceholders

A set of sources to provide placeholders for. A placeholder will provide a TrackReference for participants that don't yet have a track published for that source. Defaults to no placeholders.

passedRoom

The room to use on, or RoomLocal if null.

onlySubscribed

If true, only return tracks that have been subscribed. Defaults to true.

@Composable
fun rememberParticipantTrackReferences(sources: List<Track.Source> = listOf( Track.Source.CAMERA, Track.Source.SCREEN_SHARE ), usePlaceholders: Set<Track.Source> = emptySet(), passedParticipant: Participant? = null, onlySubscribed: Boolean = true): List<TrackReference>

Returns an array of TrackReferences for a participant depending the sources provided.

Parameters

sources

The sources of the tracks to provide. Defaults to camera and screen share tracks.

usePlaceholders

A set of sources to provide placeholders for. A placeholder will provide a TrackReference for participants that don't yet have a track published for that source. Defaults to no placeholders.

passedParticipant

The participant to use on, or ParticipantLocal if null/not passed.

onlySubscribed

If true, only return tracks that have been subscribed. Defaults to true.