Deprecate useMediaTrackByName in favor of useTrackByName

livekit · Sep 8, 2023 · 8bd6a0f · 8bd6a0f
1 parent 4144ddc
commit 8bd6a0f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/packages/react/src/hooks/index.ts b/packages/react/src/hooks/index.ts
@@ -41,3 +41,5 @@ export { UseTrackMutedIndicatorOptions, useTrackMutedIndicator } from './useTrac
 export { UseTrackToggleProps, useTrackToggle } from './useTrackToggle';
 export { UseTracksHookReturnType, UseTracksOptions, useTracks } from './useTracks';
 export { UseVisualStableUpdateOptions, useVisualStableUpdate } from './useVisualStableUpdate';
+export * from './useTrack';
+export * from './useTrackByName';
diff --git a/packages/react/src/hooks/useMediaTrackByName.ts b/packages/react/src/hooks/useMediaTrackByName.ts
@@ -3,7 +3,10 @@ import { useEnsureParticipant } from '../context';
 import type { UseMediaTrackOptions } from './useMediaTrack';
 import { useMediaTrackBySourceOrName } from './useMediaTrackBySourceOrName';
 
-/** @public */
+/**
+ * @public
+ * @deprecated this function will be removed in a future version, use `useTrackByName` instead
+ */
 export function useMediaTrackByName(
   name: string,
   participant?: Participant,

diff --git a/packages/react/src/hooks/useTrackByName.ts b/packages/react/src/hooks/useTrackByName.ts
@@ -0,0 +1,16 @@
+import { useEnsureTrackRef } from '../context';
+import type { UseMediaTrackOptions } from './useMediaTrack';
+import { useMediaTrackBySourceOrName } from './useMediaTrackBySourceOrName';
+import type { TrackReferenceOrPlaceholder } from '@livekit/components-core';
+
+/**
+ * @public
+ * @deprecated this function will be removed in a future version, use `useTrackByName` instead
+ */
+export function useMediaTrackByName(
+  trackRef?: TrackReferenceOrPlaceholder,
+  options: UseMediaTrackOptions = {},
+) {
+  const ref = useEnsureTrackRef(trackRef);
+  return useMediaTrackBySourceOrName(ref, options);
+}