Skip to main content

useVideoSummary

@fovea/annotation-tool


@fovea/annotation-tool / hooks/useSummaries / useVideoSummary

Function: useVideoSummary()

useVideoSummary(videoId, personaId, options?): UseQueryResult<null | VideoSummary, ApiError>

Defined in: src/hooks/useSummaries.ts:65

Fetch a specific summary for a video and persona. Returns null if the summary does not exist.

Parameters

videoId

string

Video identifier

personaId

string

Persona identifier

options?

Omit<UseQueryOptions<null | VideoSummary, ApiError, null | VideoSummary, readonly unknown[]>, "queryKey" | "queryFn">

TanStack Query options

Returns

UseQueryResult<null | VideoSummary, ApiError>

Query result with summary data or null