diff --git a/.changeset/slow-swans-invite.md b/.changeset/slow-swans-invite.md new file mode 100644 index 000000000..9874ad2eb --- /dev/null +++ b/.changeset/slow-swans-invite.md @@ -0,0 +1,6 @@ +--- +"@livekit/components-core": patch +"@livekit/components-react": patch +--- + +chore(react): deprecate legacy useTrackTranscriptions diff --git a/packages/core/etc/components-core.api.md b/packages/core/etc/components-core.api.md index 99cf7198d..b09d88a03 100644 --- a/packages/core/etc/components-core.api.md +++ b/packages/core/etc/components-core.api.md @@ -412,6 +412,8 @@ export type PinState = TrackReferenceOrPlaceholder[]; // @public (undocumented) export interface ReceivedChatMessage extends ChatMessage { + // (undocumented) + attributes?: Record; // (undocumented) from?: Participant; } diff --git a/packages/react/etc/components-react.api.md b/packages/react/etc/components-react.api.md index acdf30abf..778600524 100644 --- a/packages/react/etc/components-react.api.md +++ b/packages/react/etc/components-react.api.md @@ -680,7 +680,7 @@ export interface TrackToggleProps extends Omit void; @@ -1185,7 +1185,7 @@ export function useTrackToggle({ source, onChange, initi export interface UseTrackToggleProps extends Omit, 'showIcon'> { } -// @alpha (undocumented) +// @alpha @deprecated (undocumented) export function useTrackTranscription(trackRef: TrackReferenceOrPlaceholder | undefined, options?: TrackTranscriptionOptions): { segments: ReceivedTranscriptionSegment[]; }; diff --git a/packages/react/src/hooks/useTrackSyncTime.ts b/packages/react/src/hooks/useTrackSyncTime.ts index 0a5b54fec..d038a0468 100644 --- a/packages/react/src/hooks/useTrackSyncTime.ts +++ b/packages/react/src/hooks/useTrackSyncTime.ts @@ -4,6 +4,7 @@ import { useObservableState } from './internal'; /** * @internal + * @deprecated this is an internal hook that's only used by deprecated APIs */ export function useTrackSyncTime(ref: TrackReferenceOrPlaceholder | undefined) { const observable = React.useMemo( diff --git a/packages/react/src/hooks/useTrackTranscription.ts b/packages/react/src/hooks/useTrackTranscription.ts index 8c917330b..83078078d 100644 --- a/packages/react/src/hooks/useTrackTranscription.ts +++ b/packages/react/src/hooks/useTrackTranscription.ts @@ -14,6 +14,7 @@ import { useTrackSyncTime } from './useTrackSyncTime'; /** * @alpha + * @deprecated Use useTranscription instead */ export interface TrackTranscriptionOptions { /** @@ -37,6 +38,7 @@ const TRACK_TRANSCRIPTION_DEFAULTS = { /** * @returns An object consisting of `segments` with maximum length of opts.bufferSize * @alpha + * @deprecated Use useTranscription instead */ export function useTrackTranscription( trackRef: TrackReferenceOrPlaceholder | undefined,