useIsMuted implementation supports 2 parameters, but TypeScript definitions only allow 1

[Mirzahmet]

Select which package(s) are affected

@livekit/components-react

Describe the bug

Hi @1egoman @lukasIO @thomasyuill-livekit ! It looks like there is a mismatch between the runtime implementation and the published TypeScript types for useIsMuted in @livekit/components-react. The actual implementation supports the following overload:
useIsMuted(source: Track.Source, options: { participant: Participant })
However, the public type definitions only expose:
useIsMuted(trackRef: TrackReferenceOrPlaceholder): boolean;
This results in a TypeScript error when using the second, documented usage pattern:
TS2554: Expected 1 arguments, but got 2

Reproduction

import { useIsMuted } from '@livekit/components-react';
import { Track } from 'livekit-client';
const isMuted = useIsMuted(Track.Source.Camera, { participant, });
This works at runtime but fails TypeScript type checking.

Logs

System Info

Environment
@livekit/components-react: "^2.9.19"
TypeScript: "~5.9.3"

Severity

blocking all usage of LiveKit

Additional Information

Expected Behavior
Either:
The public .d.ts file should include the second overload, or
The documentation/examples should only reference the trackRef-based usage.

[1egoman]

@Mirzahmet From what I can tell piecing together the git history, I'm pretty sure useIsMuted used to have an overload allowing a user to pass in a Track.Source and a Participant together instead of a TrackReferenceOrPlceholder, and this is an old way of doing things which was deprecated here. Then I think at a later date that @deprecated second function overload was removed (while the main function continued to allow these parameters to be passed). It's unclear to me why that overload was removed - I'll reach out to some folks internally to see if they can remember any context. But given this, if there are still references to this old way of doing things you are seeing, please post them here - I think they are old / out of date and need to be modernized.

Either way, the below is a better way to do this without relying on the old deprecated signature:

const [trackRef] = useParticipantTracks([Track.Source.Microphone /* source here */], {
  participantIdentity: "xxx", /* participant identity here */
});
const isMuted = useIsMuted(trackRef);

The documentation/examples should only reference the trackRef-based usage.

Which example are you seeing this used in? I see it used only here and that is the TrackReference-based version.

[Mirzahmet]

@Mirzahmet From what I can tell piecing together the git history, I'm pretty sure useIsMuted used to have an overload allowing a user to pass in a Track.Source and a Participant together instead of a TrackReferenceOrPlceholder, and this is an old way of doing things which was deprecated here. Then I think at a later date that @deprecated second function overload was removed (while the main function continued to allow these parameters to be passed). It's unclear to me why that overload was removed - I'll reach out to some folks internally to see if they can remember any context. But given this, if there are still references to this old way of doing things you are seeing, please post them here - I think they are old / out of date and need to be modernized.

Either way, the below is a better way to do this without relying on the old deprecated signature:

const [trackRef] = useParticipantTracks([Track.Source.Microphone /* source here /], {
participantIdentity: "xxx", / participant identity here */
});
const isMuted = useIsMuted(trackRef);

The documentation/examples should only reference the trackRef-based usage.

Which example are you seeing this used in? I see it used only here and that is the TrackReference-based version.

Hi! https://docs.livekit.io/reference/components/react/hook/useismuted/

[1egoman]

@Mirzahmet Ah I see, thank you! That should be removed shortly, once this is merged.