Referencia del SDK
Cada export de @neurologyca/capture 0.45.0 y @neurologyca/capture-server 0.20.1, por entrada, con su firma y la página que lo explica.
En esta página
- @neurologyca/capture
- Funciones
- Clases
- Interfaces
- Tipos
- Constantes
- Re-exports
- @neurologyca/capture/record
- Funciones
- Clases
- Interfaces
- Tipos
- Constantes
- @neurologyca/capture/helpers
- Funciones
- Interfaces
- Tipos
- @neurologyca/capture/replay
- Funciones
- Clases
- Interfaces
- Tipos
- Constantes
- @neurologyca/capture-server
- Funciones
- Clases
- Interfaces
- Tipos
- Constantes
- @neurologyca/capture-server/node
- Funciones
- Interfaces
Generada de los tipos publicados de @neurologyca/capture 0.45.0 y @neurologyca/capture-server 0.20.1. Cada export lleva su firma y, si la tiene, la página que lo explica. Los nombres son los del paquete, en inglés. Esta página se genera con npm run docs:gen; no se edita a mano.
@neurologyca/capture
Sección titulada «@neurologyca/capture»Funciones
Sección titulada «Funciones»abandonUpload· function · Diferido (en servidor)
declare function abandonUpload(captureId: string, opts: AbandonUploadOptions): Promise<void>;captureCacheStatus· function · En el dispositivo (tiempo real)
declare function captureCacheStatus(opts?: CaptureCacheStatusOptions): Promise<PrepareCacheStatus>;classifyMediaError· function · Steps y marcado
declare function classifyMediaError(e: unknown, env?: { isSecureContext?: boolean; hasMediaDevices?: boolean; }): MediaProblem | null;consumeSse· function · En el dispositivo (tiempo real)
declare function consumeSse(body: ReadableStream<Uint8Array>, onEvent: (event: string, data: unknown) => void): Promise<void>;createGazeTracker· function · sin guía
declare function createGazeTracker(opts?: GazeTrackerOptions): GazeTracker;createProtocolClient· function · En el dispositivo (tiempo real)
declare function createProtocolClient(config: ProtocolClientConfig): ProtocolClientHandle;createRecordingClient· function · Diferido (en servidor)
declare function createRecordingClient(config: RecordingClientConfig): RecordingClientHandle;defineTenantConfig· function · En el dispositivo (tiempo real)
declare function defineTenantConfig(config: TenantConfig): TenantConfig;describeStep· function · Steps y marcado
declare function describeStep(step: PlanStep, opts?: { lang?: string; }): StepFacts;forgetTranscriptionVeto· function · En el dispositivo (tiempo real)
declare function forgetTranscriptionVeto(kodec: VideoVetoTarget): Promise<unknown | null>;guardUnload· function · Steps y marcado
declare function guardUnload(isUnsafe?: () => boolean): () => void;keepScreenOn· function · Steps y marcado
declare function keepScreenOn(): Promise<{ supported: boolean; release(): void; }>;listPendingRecordings· function · Diferido (en servidor)
declare function listPendingRecordings(opts?: ListPendingRecordingsOptions): Promise<RecordingResult[]>;makeKodecStt· function · En el dispositivo (tiempo real)
declare function makeKodecStt(host: KodecSttHost, opts?: KodecSttOptions): (cfg: TranscribeConfig) => SttProvider;normalizeSource· function · En el dispositivo (tiempo real)
declare function normalizeSource(src: MediaStream | HTMLVideoElement | CaptureSource): CaptureSource;prepareCapture· function · En el dispositivo (tiempo real)
declare function prepareCapture(opts: PrepareCaptureOptions): Promise<PrepareResult>;readScoreIndex· function · HCIs y resultados
declare function readScoreIndex(structured: unknown, key?: ScoreIndexKey, opts?: ReadScoreIndexOptions): ScoreIndex | null;readTranscriptionVeto· function · En el dispositivo (tiempo real)
declare function readTranscriptionVeto(kodec: VideoVetoTarget): Promise<{ veto: unknown | null; learned: unknown; }>;resolveTaxonomy· function · En el dispositivo (tiempo real)
declare function resolveTaxonomy(config: TenantConfig, mechanicName?: string): Taxonomy2;startOrAsk· function · Steps y marcado
declare function startOrAsk<T>(start: (discardPending: boolean) => Promise<T>, ask: (holder: PositionHolder | null) => Promise<boolean>): Promise<T | null>;sttBlockerOf· function · En el dispositivo (tiempo real)
declare function sttBlockerOf(e: unknown): SttBlocker | undefined;uploadRecording· function · Diferido (en servidor)
declare function uploadRecording(rec: RecordingResult, opts: UploadRecordingOptions): Promise<UploadRecordingResult>;urlTokenProvider· function · En el dispositivo (tiempo real)
declare function urlTokenProvider(tokenUrl: string, opts?: { method?: 'GET' | 'POST'; timeoutMs?: number; credentials?: RequestCredentials; }): TokenProvider;validateManifest· function · Diferido (en servidor)
declare function validateManifest(m: RecordingManifest, opts?: { durationMs?: number | null; }): string[];waitForPortraitOrientation· function · Steps y marcado
declare function waitForPortraitOrientation(opts?: { handheld?: boolean; signal?: AbortSignal; }): Promise<{ handheld: boolean | null; waited: boolean; }>;
AnalysisFailedError· class · Errores, avisos y reintentos
declare class AnalysisFailedError extends ProtocolUsageErrorBaselineIncompleteError· class · Errores, avisos y reintentos
declare class BaselineIncompleteError extends ProtocolUsageErrorBaselineRequestError· class · Errores, avisos y reintentos
declare class BaselineRequestError extends ProtocolUsageErrorCadenceError· class · Errores, avisos y reintentos
declare class CadenceError extends ProtocolUsageErrorCaptureAbortedError· class · Errores, avisos y reintentos
declare class CaptureAbortedError extends ProtocolUsageErrorCaptureIdInUseError· class · Errores, avisos y reintentos
declare class CaptureIdInUseError extends ProtocolUsageErrorCaptureStartError· class · Errores, avisos y reintentos
declare class CaptureStartError extends ProtocolUsageErrorEmptyStepError· class · Errores, avisos y reintentos
declare class EmptyStepError extends ProtocolUsageErrorFlowUnsupportedError· class · Errores, avisos y reintentos
declare class FlowUnsupportedError extends ProtocolUsageErrorHttpError· class · Errores, avisos y reintentos
declare class HttpError extends ErrorKodecFrameSource· class · En el dispositivo (tiempo real)
declare class KodecFrameSource implements FrameSourceKodecSttRefused· class · En el dispositivo (tiempo real)
declare class KodecSttRefused extends ErrorMediaUnknownError· class · Errores, avisos y reintentos
declare class MediaUnknownError extends ProtocolUsageErrorPlanIncompleteError· class · Errores, avisos y reintentos
declare class PlanIncompleteError extends ProtocolUsageErrorPrepareError· class · Errores, avisos y reintentos
declare class PrepareError extends ProtocolUsageErrorProtocolConflictError· class · Errores, avisos y reintentos
declare class ProtocolConflictError extends Error implements ProtocolErrorProtocolUsageError· class · Errores, avisos y reintentos
declare abstract class ProtocolUsageError extends ErrorRecorderUnsupportedError· class · Errores, avisos y reintentos
declare class RecorderUnsupportedError extends ProtocolUsageErrorRecordingLostError· class · Errores, avisos y reintentos
declare class RecordingLostError extends ProtocolUsageErrorSessionDirtyError· class · Errores, avisos y reintentos
declare class SessionDirtyError extends ProtocolUsageErrorSessionInvalidError· class · Errores, avisos y reintentos
declare class SessionInvalidError extends ProtocolUsageErrorStepDurationError· class · Errores, avisos y reintentos
declare class StepDurationError extends ProtocolUsageErrorStepSequenceError· class · Errores, avisos y reintentos
declare class StepSequenceError extends ProtocolUsageErrorStorageFullError· class · Errores, avisos y reintentos
declare class StorageFullError extends ProtocolUsageErrorTaxonomyInvalidError· class · Errores, avisos y reintentos
declare class TaxonomyInvalidError extends ProtocolUsageErrorUnknownOptionError· class · Errores, avisos y reintentos
declare class UnknownOptionError extends ProtocolUsageErrorUploadRecordingError· class · Errores, avisos y reintentos
declare class UploadRecordingError extends Error
Interfaces
Sección titulada «Interfaces»AbandonUploadOptions· interface · Diferido (en servidor)
interface AbandonUploadOptions
miembros:credentials·headers·signal·urlAnalyzeAnswer· interface · Errores, avisos y reintentos
interface AnalyzeAnswer
miembros:fromCache·inProgress·interpretation·raw·retryAfterMsBackendFrame· interface · En el dispositivo (tiempo real)
interface BackendFrame
miembros:audio·blendshapes·body·clientTsMs·featuresMeta·gaze·hands·headPose·landmarks·mediaTimeMs·rppgBaseline2Info· interface · Baseline
interface Baseline2Info
miembros:expiryDays·isValid·lastUpdatedAtBaselineCaptureOpts· interface · Baseline
interface BaselineCaptureOpts
miembros:durationMs·onProgress·onStarted·signal·source·userIdBaselineCaptureResult· interface · Baseline
interface BaselineCaptureResult
miembros:complete·framesReceived·framesReceivedWithoutFeaturesMeta·framesSent·framesSentWithoutFeaturesMeta·framesWithoutPose·missingOrders·packets·packetsExpected·packetsReceivedBaselineProgress· interface · Baseline
interface BaselineProgress
miembros:elapsedMs·fraction·totalMsCalibrateOptions· interface · sin guía
interface CalibrateOptions
miembros:managedBySdk·onNotice·onTarget·points·signalCalibrationReport· interface · sin guía
interface CalibrationReport
miembros:attempts·centered·endedAt·gainY·offset·ok·points·quality·reason·repeatedFor·samples·startedAt·warningsCalibrationTarget· interface · sin guía
interface CalibrationTarget
miembros:index·phase·total·x·yCaptureOutcome· interface · HCIs y resultados
interface CaptureOutcome
miembros:frameCount·hcis·hcisByStep·interpretation·status·structuredCaptureProtocolOpts· interface · En el dispositivo (tiempo real)
interface CaptureProtocolOpts
miembros:captureId·dangerouslyIgnoreCadence·discardPending·gaze·interpretation·mediaClock·onStarted·protocolMechanicId·signal·sleepBand·source·taxonomy·transcribe·triggerAnalysis·userProtocolIdCaptureQualitySummary· interface · HCIs y resultados
interface CaptureQualitySummary
miembros:capture·delegate·droppedTotal·fps·maxFps·minFps·windowsChannelSelection· interface · En el dispositivo (tiempo real)
interface ChannelSelection
miembros:audio·body·hands·pulseConflictDetail· interface · Errores, avisos y reintentos
interface ConflictDetail
miembros:captureId·capturedAt·earliestAt·expected·expired·goToPosition·hint·holder·latestAnalysedAt·raw·reason·ruleDeviceCheck· interface · En el dispositivo (tiempo real)
interface DeviceCheck
miembros:id·measured·reason·statusEngineToken· interface · En el dispositivo (tiempo real)
interface EngineToken
miembros:expiresAt·tokenFrameClockStats· interface · En el dispositivo (tiempo real)
interface FrameClockStats
miembros:head·iqr·max·mean·min·n·overflow·p25·p50·p75·saturated·slopeMsPerSec·tail·underflowFrameGaze· interface · sin guía
interface FrameGaze
miembros:isFixating·point·region·spread·stimulusFrameSource· interface · En el dispositivo (tiempo real)
interface FrameSource
miembros:kodecSessionId·ownsLoadClock·start·stopFrameSourceCallbacks· interface · En el dispositivo (tiempo real)
interface FrameSourceCallbacks
miembros:onCameraReady·onCodecError·onCodecEvent·onFrame·onLandmarks·onLive·onSignals·onStarted·onTranscriptionCutGazeFrame· interface · sin guía
interface GazeFrame
miembros:clientTsMs·featuresMeta·headPose·landmarksGazePoint· interface · sin guía
interface GazePoint
miembros:x·yGazeSample· interface · sin guía
interface GazeSample
miembros:fixating·point·region·spread·tMsGazeTracker· interface · sin guía
interface GazeTracker
miembros:calibrate·calibrated·forFrame·history·last·push·recalibrate·setGlasses·setStimulusGazeTrackerOptions· interface · sin guía
interface GazeTrackerOptions
miembros:glasses·now·onGazeKodecSttHost· interface · En el dispositivo (tiempo real)
interface KodecSttHost
miembros:kodec·mediaStreamKodecSttOptions· interface · En el dispositivo (tiempo real)
interface KodecSttOptions
miembros:awaitVideoProof·canTranscribe·enable·flushTimeoutMs·limitsKodecSttTarget· interface · En el dispositivo (tiempo real)
interface KodecSttTarget
miembros:captureQuality·disableLocalTranscription·enableLocalTranscription·flushLocalTranscription·models·pauseLocalTranscription·resumeLocalTranscription·sessionSpeech·takeTranscriptDelta·transcriptionCutBy·transcriptionLoad·transcriptionStatsKodecTuning· interface · En el dispositivo (tiempo real)
interface KodecTuning
miembros:capture·delegate·faceModel·handModel·poseModel·visionUrl·wasmUrlListPendingRecordingsOptions· interface · Diferido (en servidor)
interface ListPendingRecordingsOptions
miembros:onWarningLiveSignal· interface · En el dispositivo (tiempo real)
interface LiveSignal
miembros:clientTsMs·headPoseManifestStep· interface · Steps y marcado
interface ManifestStep
miembros:endMediaMs·endedBy·mediaPid·order·startMediaMs·typeModeDecision· interface · En el dispositivo (tiempo real)
interface ModeDecision
miembros:by·mode·probeFps·reasonModelDownload· interface · En el dispositivo (tiempo real)
interface ModelDownload
miembros:files·filesDone·loadedBytes·totalBytes·totalKnownModelSelection· interface · En el dispositivo (tiempo real)
interface ModelSelection
miembros:body·handsPlanStep· interface · Steps y marcado
interface PlanStep
miembros:category·delivery·description·expectsSpeech·maxTimeSeconds·media·minTimeSeconds·optional·order·phases·presentationSeconds·rounds·targetConstellationHciId·typePositionHolder· interface · En el dispositivo (tiempo real)
interface PositionHolder
miembros:captureId·capturedAt·deferred·finished·receivingPackets·recordingEndedAtPositionState· interface · En el dispositivo (tiempo real)
interface PositionState
miembros:completed·mechanicName·position·protocolMechanicIdPrepareCacheStatus· interface · En el dispositivo (tiempo real)
interface PrepareCacheStatus
miembros:faceModel·speechWeights·sttLibrary·sttRuntime·visionRuntimePrepareCaptureOptions· interface · En el dispositivo (tiempo real)
interface PrepareCaptureOptions
miembros:kodec·level·models·onStartupStage·onWarning·prepare·signal·startup·tenant·throwOnFailure·transcribePrepareOptions· interface · En el dispositivo (tiempo real)
interface PrepareOptions
miembros:level·models·signal·throwOnFailure·timeoutsPrepareResult· interface · En el dispositivo (tiempo real)
interface PrepareResult
miembros:cache·capture·cutBy·device·estimatedSpeechMs·face·level·messageKey·outcome·partialReason·report·stages·transcription·transcriptionGate·userMessagePreparedBlock· interface · En el dispositivo (tiempo real)
interface PreparedBlock
miembros:face·faceReloaded·level·origin·prepareId·speechProtocolClientConfig· interface · En el dispositivo (tiempo real)
interface ProtocolClientConfig
miembros:analyzeTimeoutMs·baseUrl·batchMs·channels·correlationId·credentials·fps·getToken·keepPrepared·kodec·makeStt·mode·models·onCodecEvent·onError·onInterpretation·onInterpretationDetails·onLandmarks·onLive·onProgress·onRecording·onReport·onResult·onSignals·onStartupStage·onStatus·onTranscript·onWarning·outcomeDeadlineMs·query·recording·requestTimeoutMs·sleepBand·startup·stepDurations·taxonomy·tenant·transcribe·transcribeStepsProtocolClientHandle· interface · En el dispositivo (tiempo real)
interface ProtocolClientHandle
miembros:analyze·cacheStatus·captureBaseline·captureProtocol·correlationPrefix·getBaselineInfo·getProtocolState·prepare·release·retrieveResultsProtocolError· interface · Errores, avisos y reintentos
interface ProtocolError
miembros:code·conflict·message·reason·recoverable·stepOrderProtocolInterpretationDetailsEvent· interface · HCIs y resultados
interface ProtocolInterpretationDetailsEvent
miembros:metadata·protocolMechanicId·raw·structured·userProtocolIdProtocolInterpretationEvent· interface · HCIs y resultados
interface ProtocolInterpretationEvent
miembros:fromCache·interpretation·metadata·protocolMechanicId·raw·structured·userProtocolIdProtocolPlan· interface · Steps y marcado
interface ProtocolPlan
miembros:flowMode·mechanicName·position·steps·timeBetweenSessionsSecondsProtocolProgressEvent· interface · En el dispositivo (tiempo real)
interface ProtocolProgressEvent
miembros:phase·routeProtocolResultEvent· interface · HCIs y resultados
interface ProtocolResultEvent
miembros:frameCount·hcis·hcisByStep·protocolMechanicId·raw·userProtocolIdProtocolSessionHandle· interface · En el dispositivo (tiempo real)
interface ProtocolSessionHandle
miembros:abort·captureId·correlationId·plan·step·stepTiming·stopProtocolState· interface · En el dispositivo (tiempo real)
interface ProtocolState
miembros:asOf·availability·baselineWarning·next·positions·progressProtocolStatusEvent· interface · En el dispositivo (tiempo real)
interface ProtocolStatusEvent
miembros:status·stepOrderProtocolStepHandle· interface · Steps y marcado
interface ProtocolStepHandle
miembros:end·run·startProtocolWarningEvent· interface · Errores, avisos y reintentos
interface ProtocolWarningEvent
miembros:blocker·captureId·code·cut·fields·hci·message·messageKey·part·reason·stage·stepOrder·subStage·userMessageReadScoreIndexOptions· interface · HCIs y resultados
interface ReadScoreIndexOptions
miembros:onWarning·onWarningRecalibrateOptions· interface · sin guía
interface RecalibrateOptions
miembros:correct·onTarget·points·signalRecalibrationPoint· interface · sin guía
interface RecalibrationPoint
miembros:deviation·dx·dy·measured·samples·targetRecalibrationReport· interface · sin guía
interface RecalibrationReport
miembros:corrected·endedAt·glasses·meanDeviation·offsetAfter·offsetBefore·points·startedAtRecordingClientConfig· interface · Diferido (en servidor)
interface RecordingClientConfig
miembros:analyzeTimeoutMs·baseUrl·credentials·getToken·onError·onRecording·onStartupStage·onWarning·recording·requestTimeoutMs·startup·stepDurations·taxonomy·tenantRecordingClientHandle· interface · Diferido (en servidor)
interface RecordingClientHandle
miembros:analyze·captureProtocol·getBaselineInfo·getProtocolState·prepare·release·retrieveResultsRecordingManifest· interface · Diferido (en servidor)
interface RecordingManifest
miembros:audioGaps·captureId·client·hidden·interpreted·orientation·orientationChanges·prerollMs·protocolMechanicId·recorder·recordingStartedAtMs·recordingStartedAtPrecisionMs·serverClockSkewMs·steps·stimulus·stopMediaMs·triggerAnalysis·userProtocolId·version·videoGapsRecordingOptions· interface · Diferido (en servidor)
interface RecordingOptions
miembros:handheld·maxFps·postrollMs·prerollMs·reserve·videoBitsPerSecondRecordingPrepareOptions· interface · Diferido (en servidor)
interface RecordingPrepareOptions
miembros:signal·throwOnFailure·timeoutsRecordingResult· interface · Diferido (en servidor)
interface RecordingResult
miembros:blob·manifest·release·storageRecordingSessionHandle· interface · Diferido (en servidor)
interface RecordingSessionHandle extends Omit<ProtocolSessionHandle, 'stop'>
miembros:result·stop·trackStimulus·abort·captureId·correlationId·plan·step·stepTiming·stopReplayReport· interface · Servicio de procesado
interface ReplayReport
miembros:cost·origin·outsideSteps·steps·transcriptionScoreIndex· interface · HCIs y resultados
interface ScoreIndex
miembros:band·degradedSignals·indicatorsUsed·label·status·value·band·degradedSignals·indicatorsUsed·label·status·valueSessionAttempt· interface · En el dispositivo (tiempo real)
interface SessionAttempt
miembros:captureId·createdAt·statusSessionReport· interface · HCIs y resultados
interface SessionReport
miembros:alignmentMisses·cancel·captureId·captureQuality·clock·codecErrors·correlationId·endedBy·finalGapWaitMs·framesBeforeFirstPacket·hiddenMs·interpretationMode·interpretationSource·kodecSessionId·modelDownload·replay·speech·startup·steps·streamDropsDuringWait·transcription·transcriptionLoad·transcriptionSetup·triggerAnalysisSourceOpts· interface · En el dispositivo (tiempo real)
interface SourceOpts
miembros:audio·channels·gaze·kodec·mediaClock·modelsSpeechSlice· interface · En el dispositivo (tiempo real)
interface SpeechSlice
miembros:endMs·language·spokenMs·startMs·step·sttModel·textStartupOptions· interface · En el dispositivo (tiempo real)
interface StartupOptions
miembros:includeUserAgent·locale·messages·report·timeoutsStartupReport· interface · En el dispositivo (tiempo real)
interface StartupReport
miembros:at·capture·context·cutBy·device·estimatedSpeechMs·kept·kind·kodecVersion·learned·level·mode·outcome·partialReason·prepared·schema·sdkVersion·seq·stages·startupId·totalMs·transcription·transcriptionGate·uaVersionToken·userAgentStartupReportOptions· interface · En el dispositivo (tiempo real)
interface StartupReportOptions
miembros:context·on·urlStartupStageEvent· interface · En el dispositivo (tiempo real)
interface StartupStageEvent
miembros:blocker·bytes·bytesPerSec·kind·messageKey·ms·parent·pending·reason·source·stage·startupId·status·total·userMessageStartupStageRecord· interface · En el dispositivo (tiempo real)
interface StartupStageRecord
miembros:blocker·bytes·ms·parent·pending·reason·source·stage·status·totalStartupTimeoutGroup· interface · En el dispositivo (tiempo real)
interface StartupTimeoutGroup
miembros:stallMs·totalMsStepFacts· interface · Steps y marcado
interface StepFacts
miembros:assets·bands·deliveryMode·expectsSpeech·maxSeconds·minSeconds·optional·order·phases·responseClock·rounds·text·texts·type·unknownStepMedia· interface · Steps y marcado
interface StepMedia
miembros:body·kind·location·pidStepPhase· interface · Steps y marcado
interface StepPhase
miembros:mediaPid·order·phase·secondsStepRunOpts· interface · Steps y marcado
interface StepRunOpts extends StepStartOpts
miembros:durationMs·mediaPidStepStartOpts· interface · Steps y marcado
interface StepStartOpts
miembros:mediaPidStepTiming· interface · Steps y marcado
interface StepTiming
miembros:elapsedMs·maxMs·maxReached·minMs·minReached·order·remainingMsStepTranscription· interface · En el dispositivo (tiempo real)
interface StepTranscription
miembros:cutsMaxLength·discarded·discardedAntiStuckMs·discardedMs·emitted·order·recoveredMs·retriedSplit·spokenMs·transcribed·typeStimulusSample· interface · Steps y marcado
interface StimulusSample
miembros:atMediaMs·event·stimulusTimeMsSttDelta· interface · En el dispositivo (tiempo real)
interface SttDelta
miembros:endMs·items·spokenMs·startMs·textSttDiagnostics· interface · En el dispositivo (tiempo real)
interface SttDiagnostics
miembros:confidenceFilter·confidenceMeasured·confidenceUnmeasurable·cutBy·discardedAnnotationOnly·discardedBySilero·discardedEmpty·discardedLowConfidence·discardedRepetitionLoop·emitted·inferenceErrors·lostOnClose·modelLoad·pending·recoveredMs·retriedSplit·usesWorker·vad·workerBlockedByCsp·workerFailedBecauseSttProvider· interface · En el dispositivo (tiempo real)
interface SttProvider
miembros:diagnostics·dispose·flush·ownsLoadClock·pause·result·resume·start·stop·takeDeltaSttResult· interface · En el dispositivo (tiempo real)
interface SttResult
miembros:accuracy·endMs·language·list·spokenMs·startMs·textSttUtterance· interface · En el dispositivo (tiempo real)
interface SttUtterance
miembros:avgLogprob·closedBy·endMs·final·lang·latencyMs·retried·silero·spokenMs·startMs·text·utteranceSeqSttWord· interface · En el dispositivo (tiempo real)
interface SttWord
miembros:timestamp·wordTaxonomy2· interface · En el dispositivo (tiempo real)
interface Taxonomy2
miembros:contextId·hciId·situationId·subcontextIdTenantConfig· interface · En el dispositivo (tiempo real)
interface TenantConfig
miembros:batchMs·engineBaseUrl·fps·taxonomy·transcribe·transcribeStepsTranscribeConfig· interface · En el dispositivo (tiempo real)
interface TranscribeConfig
miembros:allowWasmWorker·device·diarization·dtype·language·minAvgLogprob·model·progress·repetitionLoop·selfHost·sileroVad·transformers·vadTranscriptEvent· interface · En el dispositivo (tiempo real)
interface TranscriptEvent
miembros:endMs·items·spokenMs·startMs·stepOrder·textTranscriptionSetup· interface · En el dispositivo (tiempo real)
interface TranscriptionSetup
miembros:artifact·backend·deviceFellBackFrom·diarization·dtype·language·languageSource·model·modelReason·provisionalVetoLifted·sileroReady·usesWorkerUploadRecordingOptions· interface · Diferido (en servidor)
interface UploadRecordingOptions
miembros:credentials·headers·onProgress·onWarning·retries·signal·urlUploadRecordingResult· interface · Diferido (en servidor)
interface UploadRecordingResult
miembros:captureId·released·sizeVideoVetoTarget· interface · En el dispositivo (tiempo real)
interface VideoVetoTarget
miembros:forgetMemoryLimit·forgetVideoVeto·learnedState
Availability· type · En el dispositivo (tiempo real)
type Availability = { canCapture: true; } | { canCapture: false; reason: 'cadence'; availableAt: Date; } | { canCapture: false; reason: 'cadence-unknown'; } | { canCapture: false; reason: 'dirty'; since: Date; } | { canCapture: false; reason: 'complete'; };CacheState· type · En el dispositivo (tiempo real)
type CacheState = 'cached' | 'not-cached' | 'unknown';CalibrationNotice· type · sin guía
type CalibrationNotice = { kind: 'instructions'; } | { kind: 'repeat'; reasons: CalibrationWarning[]; attempt: number; };CalibrationWarning· type · sin guía
type CalibrationWarning = 'low-frame-rate' | 'weak-vertical-signal' | 'glasses' | 'head-moved';CaptureCacheStatusOptions· type · En el dispositivo (tiempo real)
type CaptureCacheStatusOptions = Omit<PrepareCaptureOptions, 'level' | 'prepare' | 'signal' | 'throwOnFailure'>;CaptureSource· type · En el dispositivo (tiempo real)
type CaptureSource = { type: 'webcam'; } | { type: 'video'; el: HTMLVideoElement; } | { type: 'stream'; stream: MediaStream; } | { type: 'frames'; };CaptureStartReason· type · Errores, avisos y reintentos
type CaptureStartReason = 'timeout' | 'error' | 'paused' | 'metadata';CaptureStartStage· type · Errores, avisos y reintentos
type CaptureStartStage = 'camera' | 'face-model' | 'first-frame' | 'source';CaptureStartSubStage· type · Errores, avisos y reintentos
type CaptureStartSubStage = 'vision-runtime' | 'face-asset' | 'vision-create';ConflictReason· type · Errores, avisos y reintentos
type ConflictReason = (typeof CONFLICT_REASONS)[number];ConflictRule· type · Errores, avisos y reintentos
type ConflictRule = 'date_window' | 'time_of_day' | 'spacing' | 'start_order' | 'start_weekday';ConflictWarning· type · Errores, avisos y reintentos
type ConflictWarning = (typeof CONFLICT_WARNINGS)[number];DeviceCheckId· type · En el dispositivo (tiempo real)
type DeviceCheckId = 'secure-context' | 'get-user-media' | 'capture-route' | 'webgpu-adapter' | 'jspi' | 'wasm-simd' | 'audio-worklet' | 'storage-persisted' | 'media-recorder-mp4' | 'indexeddb' | 'storage-quota';HciMeans· type · HCIs y resultados
type HciMeans = Record<string, number>;InterpretationMode· type · En el dispositivo (tiempo real)
type InterpretationMode = 'engine' | 'stream';InterpretationSource· type · HCIs y resultados
type InterpretationSource = 'sse' | 'analyze-cache' | 'analyze-generated' | 'analyze' | 'stream';MediaProblem· type · Steps y marcado
type MediaProblem = 'denied' | 'no-device' | 'in-use' | 'constraints' | 'insecure-context' | 'no-frames' | 'recorder-unsupported' | 'model-load';PartialReason· type · En el dispositivo (tiempo real)
type PartialReason = 'speech-timeout' | 'speech-error' | 'speech-unavailable' | 'speech-not-prepared' | 'speech-gate-timeout';PrepareErrorReason· type · Errores, avisos y reintentos
type PrepareErrorReason = 'failed' | 'aborted' | 'capture-in-progress';PrepareLevel· type · En el dispositivo (tiempo real)
type PrepareLevel = 'memory' | 'cache';PreparedOrigin· type · En el dispositivo (tiempo real)
type PreparedOrigin = 'prepare' | 'previous-session';PreparedPartUse· type · En el dispositivo (tiempo real)
type PreparedPartUse = 'adopted' | 'stale' | 'unused' | 'not-prepared';ProtocolErrorCode· type · Errores, avisos y reintentos
type ProtocolErrorCode = 'E_HTTP' | 'E_RESULTS_TIMEOUT' | 'E_RESULTS_EMPTY' | 'E_INTERPRETATION_TIMEOUT' | 'E_ANALYSIS_IN_PROGRESS' | 'E_PROCESSING' | 'E_FRAMES_DISCARDED' | 'E_UPLOAD_FAILED' | 'E_STEP_LOST' | 'E_CAPTURE_LOST' | 'E_RECORDING_LOST' | 'E_AXES_MISSING' | 'E_NARRATIVE_REJECTED' | 'E_TAXONOMY_REJECTED' | 'E_TENANT_UNKNOWN' | 'E_ANALYSIS_FAILED' | 'E_CONFLICT';ProtocolStatus· type · En el dispositivo (tiempo real)
type ProtocolStatus = 'authenticating' | 'streaming-open' | 'capturing' | 'transcribing' | 'step-started' | 'step-complete' | 'processing' | 'results-ready' | 'interpretation-ready' | 'complete' | 'timeout' | 'cancelled' | 'invalidated';ScoreIndexKey· type · HCIs y resultados
type ScoreIndexKey = 'wellness_index' | (string & {});ScoreIndexStatus· type · HCIs y resultados
type ScoreIndexStatus = 'ok' | 'degraded' | 'not_shown';StartupFailReason· type · En el dispositivo (tiempo real)
type StartupFailReason = 'timeout' | 'network' | 'aborted' | 'refused' | 'unsupported' | 'error';StartupLocale· type · En el dispositivo (tiempo real)
type StartupLocale = 'es' | 'en';StartupMessageKey· type · En el dispositivo (tiempo real)
type StartupMessageKey = 'startup.preparing' | 'face-model.running' | 'face-model.cached' | 'speech.running' | 'speech.stalled' | 'speech.timeout' | 'speech.unavailable' | 'face-model.stalled' | 'face-model.timeout' | 'face-model.error' | 'first-frame.timeout' | 'first-frame.timeout-media' | 'first-frame.face-reload-failed' | 'camera.timeout' | 'capture.aborted' | 'startup.ready' | 'prepare.speech-timeout' | 'prepare.speech-error' | 'prepare.aborted' | 'prepare.record-unsupported';StartupOutcome· type · En el dispositivo (tiempo real)
type StartupOutcome = 'ready' | 'partial' | 'failed' | 'aborted' | 'unfinished';StartupStage· type · En el dispositivo (tiempo real)
type StartupStage = 'engine-setup' | 'device' | 'camera' | 'face-model' | 'first-frame' | 'speech' | 'engine-session';StartupStagePending· type · En el dispositivo (tiempo real)
type StartupStagePending = 'provisional-video-veto' | 'another-load';StartupStageStatus· type · En el dispositivo (tiempo real)
type StartupStageStatus = 'pending' | 'running' | 'stalled' | 'done' | 'failed' | 'skipped';StartupSubStage· type · En el dispositivo (tiempo real)
type StartupSubStage = 'vision-runtime' | 'face-asset' | 'vision-create' | 'stt-library' | 'stt-weights' | 'stt-runtime' | 'stt-session' | 'vad';StepDelivery· type · En el dispositivo (tiempo real)
type StepDelivery = { response_clock?: string; mode?: string; } & Record<string, unknown>;StepDurationsMode· type · Steps y marcado
type StepDurationsMode = 'warn' | 'enforce' | 'off';StimulusElement· type · sin guía
type StimulusElement = HTMLVideoElement | HTMLImageElement;SttBlocker· type · En el dispositivo (tiempo real)
type SttBlocker = (typeof STT_BLOCKERS)[number];SttSileroMeasure· type · En el dispositivo (tiempo real)
type SttSileroMeasure = { windows: number; voiced?: number; ratio: number | null; mean: number | null; max: number | null; accepted: boolean; } | { error: string; };TokenProvider· type · En el dispositivo (tiempo real)
type TokenProvider = () => Promise<EngineToken>;TranscriptionCut· type · En el dispositivo (tiempo real)
type TranscriptionCut = unknown;UploadRecordingErrorCode· type · Errores, avisos y reintentos
type UploadRecordingErrorCode = 'E_UPLOAD_NETWORK' | 'E_UPLOAD_NOT_NOTIFIED' | 'E_UPLOAD_AUTH' | 'E_UPLOAD_REJECTED' | 'E_UPLOAD_CONFLICT' | 'E_UPLOAD_TOO_LARGE' | 'E_UPLOAD_LOCAL_UNREADABLE' | 'E_UPLOAD_PROTOCOL' | 'E_UPLOAD_ABORTED';
Constantes
Sección titulada «Constantes»CONFLICT_REASONS· const · Errores, avisos y reintentos
declare const CONFLICT_REASONS: readonly ["SESSION_ABANDONED", "POSITION_ALREADY_COMPLETED", "MECHANIC_EXPIRED", "MECHANIC_NOT_YET_AVAILABLE", "MUST_START_AT_FIRST_POSITION", "PROTOCOL_DEPRECATED", "POSITION_RESERVED", "CAPTURE_DISCARDED", "CAPTURE_OUT_OF_ORDER", "PROTOCOL_NOT_ANALYSED", "CAPTURE_CANCELLED"];CONFLICT_WARNINGS· const · Errores, avisos y reintentos
declare const CONFLICT_WARNINGS: readonly ["conflict.unknown-reason", "conflict.ambiguous-goto", "conflict.earliestAt-assumed-utc"];DEFAULT_CALIBRATION_POINTS· const · sin guía
declare const DEFAULT_CALIBRATION_POINTS: GazePoint[];DEFAULT_RECALIBRATION_POINTS· const · sin guía
declare const DEFAULT_RECALIBRATION_POINTS: GazePoint[];FORWARDED_CODEC_EVENTS· const · En el dispositivo (tiempo real)
declare const FORWARDED_CODEC_EVENTS: readonly string[];STARTUP_MESSAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_MESSAGES: Readonly<Record<StartupLocale, Readonly<Record<StartupMessageKey, string>>>>;STARTUP_MESSAGE_KEYS· const · En el dispositivo (tiempo real)
declare const STARTUP_MESSAGE_KEYS: readonly StartupMessageKey[];STARTUP_STAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_STAGES: readonly StartupStage[];STARTUP_SUB_STAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_SUB_STAGES: readonly StartupSubStage[];STT_BLOCKERS· const · En el dispositivo (tiempo real)
declare const STT_BLOCKERS: readonly ["no-webgpu", "ladder-exhausted", "video-cost-veto", "no-memory-to-learn", "dtype-required"];
Re-exports
Sección titulada «Re-exports»FeatureMeta· re-exportado de@neurologyca/kodecLiveLandmarks· re-exportado de@neurologyca/kodecLiveSignals· re-exportado de@neurologyca/kodeckodec· re-exportado de@neurologyca/kodec
@neurologyca/capture/record
Sección titulada «@neurologyca/capture/record»Funciones
Sección titulada «Funciones»abandonUpload· function · Diferido (en servidor)
declare function abandonUpload(captureId: string, opts: AbandonUploadOptions): Promise<void>;createRecordingClient· function · Diferido (en servidor)
declare function createRecordingClient(config: RecordingClientConfig): RecordingClientHandle;defineTenantConfig· function · En el dispositivo (tiempo real)
declare function defineTenantConfig(config: TenantConfig): TenantConfig;describeStep· function · Steps y marcado
declare function describeStep(step: PlanStep, opts?: { lang?: string; }): StepFacts;listPendingRecordings· function · Diferido (en servidor)
declare function listPendingRecordings(opts?: ListPendingRecordingsOptions): Promise<RecordingResult[]>;uploadRecording· function · Diferido (en servidor)
declare function uploadRecording(rec: RecordingResult, opts: UploadRecordingOptions): Promise<UploadRecordingResult>;urlTokenProvider· function · En el dispositivo (tiempo real)
declare function urlTokenProvider(tokenUrl: string, opts?: { method?: 'GET' | 'POST'; timeoutMs?: number; credentials?: RequestCredentials; }): TokenProvider;validateManifest· function · Diferido (en servidor)
declare function validateManifest(m: RecordingManifest, opts?: { durationMs?: number | null; }): string[];
AnalysisFailedError· class · Errores, avisos y reintentos
declare class AnalysisFailedError extends ProtocolUsageErrorCadenceError· class · Errores, avisos y reintentos
declare class CadenceError extends ProtocolUsageErrorCaptureAbortedError· class · Errores, avisos y reintentos
declare class CaptureAbortedError extends ProtocolUsageErrorCaptureIdInUseError· class · Errores, avisos y reintentos
declare class CaptureIdInUseError extends ProtocolUsageErrorCaptureStartError· class · Errores, avisos y reintentos
declare class CaptureStartError extends ProtocolUsageErrorFlowUnsupportedError· class · Errores, avisos y reintentos
declare class FlowUnsupportedError extends ProtocolUsageErrorHttpError· class · Errores, avisos y reintentos
declare class HttpError extends ErrorMediaUnknownError· class · Errores, avisos y reintentos
declare class MediaUnknownError extends ProtocolUsageErrorPlanIncompleteError· class · Errores, avisos y reintentos
declare class PlanIncompleteError extends ProtocolUsageErrorPrepareError· class · Errores, avisos y reintentos
declare class PrepareError extends ProtocolUsageErrorProtocolConflictError· class · Errores, avisos y reintentos
declare class ProtocolConflictError extends Error implements ProtocolErrorProtocolUsageError· class · Errores, avisos y reintentos
declare abstract class ProtocolUsageError extends ErrorRecorderUnsupportedError· class · Errores, avisos y reintentos
declare class RecorderUnsupportedError extends ProtocolUsageErrorRecordingLostError· class · Errores, avisos y reintentos
declare class RecordingLostError extends ProtocolUsageErrorSessionDirtyError· class · Errores, avisos y reintentos
declare class SessionDirtyError extends ProtocolUsageErrorStepDurationError· class · Errores, avisos y reintentos
declare class StepDurationError extends ProtocolUsageErrorStepSequenceError· class · Errores, avisos y reintentos
declare class StepSequenceError extends ProtocolUsageErrorStorageFullError· class · Errores, avisos y reintentos
declare class StorageFullError extends ProtocolUsageErrorTaxonomyInvalidError· class · Errores, avisos y reintentos
declare class TaxonomyInvalidError extends ProtocolUsageErrorUnknownOptionError· class · Errores, avisos y reintentos
declare class UnknownOptionError extends ProtocolUsageErrorUploadRecordingError· class · Errores, avisos y reintentos
declare class UploadRecordingError extends Error
Interfaces
Sección titulada «Interfaces»AbandonUploadOptions· interface · Diferido (en servidor)
interface AbandonUploadOptions
miembros:credentials·headers·signal·urlAnalyzeAnswer· interface · Errores, avisos y reintentos
interface AnalyzeAnswer
miembros:fromCache·inProgress·interpretation·raw·retryAfterMsBaseline2Info· interface · Baseline
interface Baseline2Info
miembros:expiryDays·isValid·lastUpdatedAtCalibrateOptions· interface · sin guía
interface CalibrateOptions
miembros:managedBySdk·onNotice·onTarget·points·signalCalibrationReport· interface · sin guía
interface CalibrationReport
miembros:attempts·centered·endedAt·gainY·offset·ok·points·quality·reason·repeatedFor·samples·startedAt·warningsCalibrationTarget· interface · sin guía
interface CalibrationTarget
miembros:index·phase·total·x·yCaptureOutcome· interface · HCIs y resultados
interface CaptureOutcome
miembros:frameCount·hcis·hcisByStep·interpretation·status·structuredCaptureProtocolOpts· interface · En el dispositivo (tiempo real)
interface CaptureProtocolOpts
miembros:captureId·dangerouslyIgnoreCadence·discardPending·gaze·interpretation·mediaClock·onStarted·protocolMechanicId·signal·sleepBand·source·taxonomy·transcribe·triggerAnalysis·userProtocolIdConflictDetail· interface · Errores, avisos y reintentos
interface ConflictDetail
miembros:captureId·capturedAt·earliestAt·expected·expired·goToPosition·hint·holder·latestAnalysedAt·raw·reason·ruleDeviceCheck· interface · En el dispositivo (tiempo real)
interface DeviceCheck
miembros:id·measured·reason·statusEngineToken· interface · En el dispositivo (tiempo real)
interface EngineToken
miembros:expiresAt·tokenFrameGaze· interface · sin guía
interface FrameGaze
miembros:isFixating·point·region·spread·stimulusGazeFrame· interface · sin guía
interface GazeFrame
miembros:clientTsMs·featuresMeta·headPose·landmarksGazePoint· interface · sin guía
interface GazePoint
miembros:x·yGazeSample· interface · sin guía
interface GazeSample
miembros:fixating·point·region·spread·tMsGazeTracker· interface · sin guía
interface GazeTracker
miembros:calibrate·calibrated·forFrame·history·last·push·recalibrate·setGlasses·setStimulusListPendingRecordingsOptions· interface · Diferido (en servidor)
interface ListPendingRecordingsOptions
miembros:onWarningManifestStep· interface · Steps y marcado
interface ManifestStep
miembros:endMediaMs·endedBy·mediaPid·order·startMediaMs·typeModeDecision· interface · En el dispositivo (tiempo real)
interface ModeDecision
miembros:by·mode·probeFps·reasonPlanStep· interface · Steps y marcado
interface PlanStep
miembros:category·delivery·description·expectsSpeech·maxTimeSeconds·media·minTimeSeconds·optional·order·phases·presentationSeconds·rounds·targetConstellationHciId·typePositionHolder· interface · En el dispositivo (tiempo real)
interface PositionHolder
miembros:captureId·capturedAt·deferred·finished·receivingPackets·recordingEndedAtPositionState· interface · En el dispositivo (tiempo real)
interface PositionState
miembros:completed·mechanicName·position·protocolMechanicIdPrepareCacheStatus· interface · En el dispositivo (tiempo real)
interface PrepareCacheStatus
miembros:faceModel·speechWeights·sttLibrary·sttRuntime·visionRuntimePrepareResult· interface · En el dispositivo (tiempo real)
interface PrepareResult
miembros:cache·capture·cutBy·device·estimatedSpeechMs·face·level·messageKey·outcome·partialReason·report·stages·transcription·transcriptionGate·userMessagePreparedBlock· interface · En el dispositivo (tiempo real)
interface PreparedBlock
miembros:face·faceReloaded·level·origin·prepareId·speechProtocolError· interface · Errores, avisos y reintentos
interface ProtocolError
miembros:code·conflict·message·reason·recoverable·stepOrderProtocolPlan· interface · Steps y marcado
interface ProtocolPlan
miembros:flowMode·mechanicName·position·steps·timeBetweenSessionsSecondsProtocolSessionHandle· interface · En el dispositivo (tiempo real)
interface ProtocolSessionHandle
miembros:abort·captureId·correlationId·plan·step·stepTiming·stopProtocolState· interface · En el dispositivo (tiempo real)
interface ProtocolState
miembros:asOf·availability·baselineWarning·next·positions·progressProtocolStepHandle· interface · Steps y marcado
interface ProtocolStepHandle
miembros:end·run·startProtocolWarningEvent· interface · Errores, avisos y reintentos
interface ProtocolWarningEvent
miembros:blocker·captureId·code·cut·fields·hci·message·messageKey·part·reason·stage·stepOrder·subStage·userMessageRecalibrateOptions· interface · sin guía
interface RecalibrateOptions
miembros:correct·onTarget·points·signalRecalibrationPoint· interface · sin guía
interface RecalibrationPoint
miembros:deviation·dx·dy·measured·samples·targetRecalibrationReport· interface · sin guía
interface RecalibrationReport
miembros:corrected·endedAt·glasses·meanDeviation·offsetAfter·offsetBefore·points·startedAtRecordingClientConfig· interface · Diferido (en servidor)
interface RecordingClientConfig
miembros:analyzeTimeoutMs·baseUrl·credentials·getToken·onError·onRecording·onStartupStage·onWarning·recording·requestTimeoutMs·startup·stepDurations·taxonomy·tenantRecordingClientHandle· interface · Diferido (en servidor)
interface RecordingClientHandle
miembros:analyze·captureProtocol·getBaselineInfo·getProtocolState·prepare·release·retrieveResultsRecordingManifest· interface · Diferido (en servidor)
interface RecordingManifest
miembros:audioGaps·captureId·client·hidden·interpreted·orientation·orientationChanges·prerollMs·protocolMechanicId·recorder·recordingStartedAtMs·recordingStartedAtPrecisionMs·serverClockSkewMs·steps·stimulus·stopMediaMs·triggerAnalysis·userProtocolId·version·videoGapsRecordingOptions· interface · Diferido (en servidor)
interface RecordingOptions
miembros:handheld·maxFps·postrollMs·prerollMs·reserve·videoBitsPerSecondRecordingPrepareOptions· interface · Diferido (en servidor)
interface RecordingPrepareOptions
miembros:signal·throwOnFailure·timeoutsRecordingResult· interface · Diferido (en servidor)
interface RecordingResult
miembros:blob·manifest·release·storageRecordingSessionHandle· interface · Diferido (en servidor)
interface RecordingSessionHandle extends Omit<ProtocolSessionHandle, 'stop'>
miembros:result·stop·trackStimulus·abort·captureId·correlationId·plan·step·stepTiming·stopStartupOptions· interface · En el dispositivo (tiempo real)
interface StartupOptions
miembros:includeUserAgent·locale·messages·report·timeoutsStartupReport· interface · En el dispositivo (tiempo real)
interface StartupReport
miembros:at·capture·context·cutBy·device·estimatedSpeechMs·kept·kind·kodecVersion·learned·level·mode·outcome·partialReason·prepared·schema·sdkVersion·seq·stages·startupId·totalMs·transcription·transcriptionGate·uaVersionToken·userAgentStartupReportOptions· interface · En el dispositivo (tiempo real)
interface StartupReportOptions
miembros:context·on·urlStartupStageEvent· interface · En el dispositivo (tiempo real)
interface StartupStageEvent
miembros:blocker·bytes·bytesPerSec·kind·messageKey·ms·parent·pending·reason·source·stage·startupId·status·total·userMessageStartupStageRecord· interface · En el dispositivo (tiempo real)
interface StartupStageRecord
miembros:blocker·bytes·ms·parent·pending·reason·source·stage·status·totalStartupTimeoutGroup· interface · En el dispositivo (tiempo real)
interface StartupTimeoutGroup
miembros:stallMs·totalMsStepFacts· interface · Steps y marcado
interface StepFacts
miembros:assets·bands·deliveryMode·expectsSpeech·maxSeconds·minSeconds·optional·order·phases·responseClock·rounds·text·texts·type·unknownStepMedia· interface · Steps y marcado
interface StepMedia
miembros:body·kind·location·pidStepPhase· interface · Steps y marcado
interface StepPhase
miembros:mediaPid·order·phase·secondsStepRunOpts· interface · Steps y marcado
interface StepRunOpts extends StepStartOpts
miembros:durationMs·mediaPidStepStartOpts· interface · Steps y marcado
interface StepStartOpts
miembros:mediaPidStepTiming· interface · Steps y marcado
interface StepTiming
miembros:elapsedMs·maxMs·maxReached·minMs·minReached·order·remainingMsStimulusSample· interface · Steps y marcado
interface StimulusSample
miembros:atMediaMs·event·stimulusTimeMsTaxonomy2· interface · En el dispositivo (tiempo real)
interface Taxonomy2
miembros:contextId·hciId·situationId·subcontextIdTenantConfig· interface · En el dispositivo (tiempo real)
interface TenantConfig
miembros:batchMs·engineBaseUrl·fps·taxonomy·transcribe·transcribeStepsTranscribeConfig· interface · En el dispositivo (tiempo real)
interface TranscribeConfig
miembros:allowWasmWorker·device·diarization·dtype·language·minAvgLogprob·model·progress·repetitionLoop·selfHost·sileroVad·transformers·vadUploadRecordingOptions· interface · Diferido (en servidor)
interface UploadRecordingOptions
miembros:credentials·headers·onProgress·onWarning·retries·signal·urlUploadRecordingResult· interface · Diferido (en servidor)
interface UploadRecordingResult
miembros:captureId·released·size
Availability· type · En el dispositivo (tiempo real)
type Availability = { canCapture: true; } | { canCapture: false; reason: 'cadence'; availableAt: Date; } | { canCapture: false; reason: 'cadence-unknown'; } | { canCapture: false; reason: 'dirty'; since: Date; } | { canCapture: false; reason: 'complete'; };CacheState· type · En el dispositivo (tiempo real)
type CacheState = 'cached' | 'not-cached' | 'unknown';CalibrationNotice· type · sin guía
type CalibrationNotice = { kind: 'instructions'; } | { kind: 'repeat'; reasons: CalibrationWarning[]; attempt: number; };CalibrationWarning· type · sin guía
type CalibrationWarning = 'low-frame-rate' | 'weak-vertical-signal' | 'glasses' | 'head-moved';CaptureSource· type · En el dispositivo (tiempo real)
type CaptureSource = { type: 'webcam'; } | { type: 'video'; el: HTMLVideoElement; } | { type: 'stream'; stream: MediaStream; } | { type: 'frames'; };CaptureStartReason· type · Errores, avisos y reintentos
type CaptureStartReason = 'timeout' | 'error' | 'paused' | 'metadata';CaptureStartStage· type · Errores, avisos y reintentos
type CaptureStartStage = 'camera' | 'face-model' | 'first-frame' | 'source';CaptureStartSubStage· type · Errores, avisos y reintentos
type CaptureStartSubStage = 'vision-runtime' | 'face-asset' | 'vision-create';ConflictReason· type · Errores, avisos y reintentos
type ConflictReason = (typeof CONFLICT_REASONS)[number];ConflictRule· type · Errores, avisos y reintentos
type ConflictRule = 'date_window' | 'time_of_day' | 'spacing' | 'start_order' | 'start_weekday';ConflictWarning· type · Errores, avisos y reintentos
type ConflictWarning = (typeof CONFLICT_WARNINGS)[number];DeviceCheckId· type · En el dispositivo (tiempo real)
type DeviceCheckId = 'secure-context' | 'get-user-media' | 'capture-route' | 'webgpu-adapter' | 'jspi' | 'wasm-simd' | 'audio-worklet' | 'storage-persisted' | 'media-recorder-mp4' | 'indexeddb' | 'storage-quota';HciMeans· type · HCIs y resultados
type HciMeans = Record<string, number>;InterpretationMode· type · En el dispositivo (tiempo real)
type InterpretationMode = 'engine' | 'stream';PartialReason· type · En el dispositivo (tiempo real)
type PartialReason = 'speech-timeout' | 'speech-error' | 'speech-unavailable' | 'speech-not-prepared' | 'speech-gate-timeout';PrepareErrorReason· type · Errores, avisos y reintentos
type PrepareErrorReason = 'failed' | 'aborted' | 'capture-in-progress';PrepareLevel· type · En el dispositivo (tiempo real)
type PrepareLevel = 'memory' | 'cache';PreparedOrigin· type · En el dispositivo (tiempo real)
type PreparedOrigin = 'prepare' | 'previous-session';PreparedPartUse· type · En el dispositivo (tiempo real)
type PreparedPartUse = 'adopted' | 'stale' | 'unused' | 'not-prepared';ProtocolErrorCode· type · Errores, avisos y reintentos
type ProtocolErrorCode = 'E_HTTP' | 'E_RESULTS_TIMEOUT' | 'E_RESULTS_EMPTY' | 'E_INTERPRETATION_TIMEOUT' | 'E_ANALYSIS_IN_PROGRESS' | 'E_PROCESSING' | 'E_FRAMES_DISCARDED' | 'E_UPLOAD_FAILED' | 'E_STEP_LOST' | 'E_CAPTURE_LOST' | 'E_RECORDING_LOST' | 'E_AXES_MISSING' | 'E_NARRATIVE_REJECTED' | 'E_TAXONOMY_REJECTED' | 'E_TENANT_UNKNOWN' | 'E_ANALYSIS_FAILED' | 'E_CONFLICT';StartupFailReason· type · En el dispositivo (tiempo real)
type StartupFailReason = 'timeout' | 'network' | 'aborted' | 'refused' | 'unsupported' | 'error';StartupLocale· type · En el dispositivo (tiempo real)
type StartupLocale = 'es' | 'en';StartupMessageKey· type · En el dispositivo (tiempo real)
type StartupMessageKey = 'startup.preparing' | 'face-model.running' | 'face-model.cached' | 'speech.running' | 'speech.stalled' | 'speech.timeout' | 'speech.unavailable' | 'face-model.stalled' | 'face-model.timeout' | 'face-model.error' | 'first-frame.timeout' | 'first-frame.timeout-media' | 'first-frame.face-reload-failed' | 'camera.timeout' | 'capture.aborted' | 'startup.ready' | 'prepare.speech-timeout' | 'prepare.speech-error' | 'prepare.aborted' | 'prepare.record-unsupported';StartupOutcome· type · En el dispositivo (tiempo real)
type StartupOutcome = 'ready' | 'partial' | 'failed' | 'aborted' | 'unfinished';StartupStage· type · En el dispositivo (tiempo real)
type StartupStage = 'engine-setup' | 'device' | 'camera' | 'face-model' | 'first-frame' | 'speech' | 'engine-session';StartupStagePending· type · En el dispositivo (tiempo real)
type StartupStagePending = 'provisional-video-veto' | 'another-load';StartupStageStatus· type · En el dispositivo (tiempo real)
type StartupStageStatus = 'pending' | 'running' | 'stalled' | 'done' | 'failed' | 'skipped';StartupSubStage· type · En el dispositivo (tiempo real)
type StartupSubStage = 'vision-runtime' | 'face-asset' | 'vision-create' | 'stt-library' | 'stt-weights' | 'stt-runtime' | 'stt-session' | 'vad';StepDelivery· type · En el dispositivo (tiempo real)
type StepDelivery = { response_clock?: string; mode?: string; } & Record<string, unknown>;StepDurationsMode· type · Steps y marcado
type StepDurationsMode = 'warn' | 'enforce' | 'off';StimulusElement· type · sin guía
type StimulusElement = HTMLVideoElement | HTMLImageElement;SttBlocker· type · En el dispositivo (tiempo real)
type SttBlocker = (typeof STT_BLOCKERS)[number];TokenProvider· type · En el dispositivo (tiempo real)
type TokenProvider = () => Promise<EngineToken>;UploadRecordingErrorCode· type · Errores, avisos y reintentos
type UploadRecordingErrorCode = 'E_UPLOAD_NETWORK' | 'E_UPLOAD_NOT_NOTIFIED' | 'E_UPLOAD_AUTH' | 'E_UPLOAD_REJECTED' | 'E_UPLOAD_CONFLICT' | 'E_UPLOAD_TOO_LARGE' | 'E_UPLOAD_LOCAL_UNREADABLE' | 'E_UPLOAD_PROTOCOL' | 'E_UPLOAD_ABORTED';
Constantes
Sección titulada «Constantes»CONFLICT_REASONS· const · Errores, avisos y reintentos
declare const CONFLICT_REASONS: readonly ["SESSION_ABANDONED", "POSITION_ALREADY_COMPLETED", "MECHANIC_EXPIRED", "MECHANIC_NOT_YET_AVAILABLE", "MUST_START_AT_FIRST_POSITION", "PROTOCOL_DEPRECATED", "POSITION_RESERVED", "CAPTURE_DISCARDED", "CAPTURE_OUT_OF_ORDER", "PROTOCOL_NOT_ANALYSED", "CAPTURE_CANCELLED"];CONFLICT_WARNINGS· const · Errores, avisos y reintentos
declare const CONFLICT_WARNINGS: readonly ["conflict.unknown-reason", "conflict.ambiguous-goto", "conflict.earliestAt-assumed-utc"];STARTUP_MESSAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_MESSAGES: Readonly<Record<StartupLocale, Readonly<Record<StartupMessageKey, string>>>>;STARTUP_MESSAGE_KEYS· const · En el dispositivo (tiempo real)
declare const STARTUP_MESSAGE_KEYS: readonly StartupMessageKey[];STARTUP_STAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_STAGES: readonly StartupStage[];STARTUP_SUB_STAGES· const · En el dispositivo (tiempo real)
declare const STARTUP_SUB_STAGES: readonly StartupSubStage[];
@neurologyca/capture/helpers
Sección titulada «@neurologyca/capture/helpers»Funciones
Sección titulada «Funciones»classifyMediaError· function · Steps y marcado
declare function classifyMediaError(e: unknown, env?: { isSecureContext?: boolean; hasMediaDevices?: boolean; }): MediaProblem | null;guardUnload· function · Steps y marcado
declare function guardUnload(isUnsafe?: () => boolean): () => void;keepScreenOn· function · Steps y marcado
declare function keepScreenOn(): Promise<{ supported: boolean; release(): void; }>;readScoreIndex· function · HCIs y resultados
declare function readScoreIndex(structured: unknown, key?: ScoreIndexKey, opts?: ReadScoreIndexOptions): ScoreIndex | null;startOrAsk· function · Steps y marcado
declare function startOrAsk<T>(start: (discardPending: boolean) => Promise<T>, ask: (holder: PositionHolder | null) => Promise<boolean>): Promise<T | null>;waitForPortraitOrientation· function · Steps y marcado
declare function waitForPortraitOrientation(opts?: { handheld?: boolean; signal?: AbortSignal; }): Promise<{ handheld: boolean | null; waited: boolean; }>;
Interfaces
Sección titulada «Interfaces»PositionHolder· interface · En el dispositivo (tiempo real)
interface PositionHolder
miembros:captureId·capturedAt·deferred·finished·receivingPackets·recordingEndedAtReadScoreIndexOptions· interface · HCIs y resultados
interface ReadScoreIndexOptions
miembros:onWarning·onWarningScoreIndex· interface · HCIs y resultados
interface ScoreIndex
miembros:band·degradedSignals·indicatorsUsed·label·status·value·band·degradedSignals·indicatorsUsed·label·status·value
MediaProblem· type · Steps y marcado
type MediaProblem = 'denied' | 'no-device' | 'in-use' | 'constraints' | 'insecure-context' | 'no-frames' | 'recorder-unsupported' | 'model-load';ScoreIndexKey· type · HCIs y resultados
type ScoreIndexKey = 'wellness_index' | (string & {});ScoreIndexStatus· type · HCIs y resultados
type ScoreIndexStatus = 'ok' | 'degraded' | 'not_shown';
@neurologyca/capture/replay
Sección titulada «@neurologyca/capture/replay»Funciones
Sección titulada «Funciones»releaseOwnReservation· function · Servicio de procesado
declare function releaseOwnReservation(c: ReleaseOwnReservationConfig, t: ReleaseOwnReservationTarget): Promise<ReleaseOwnReservationResult>;replayRecording· function · Servicio de procesado
declare function replayRecording(config: ReplayConfig, input: ReplayInput): Promise<ReplayResult>;urlTokenProvider· function · En el dispositivo (tiempo real)
declare function urlTokenProvider(tokenUrl: string, opts?: { method?: 'GET' | 'POST'; timeoutMs?: number; credentials?: RequestCredentials; }): TokenProvider;validateManifest· function · Diferido (en servidor)
declare function validateManifest(m: RecordingManifest, opts?: { durationMs?: number | null; }): string[];
AlreadyProcessedError· class · Errores, avisos y reintentos
declare class AlreadyProcessedError extends ReplayErrorCaptureDiscardedError· class · Errores, avisos y reintentos
declare class CaptureDiscardedError extends ReplayErrorCaptureOutOfOrderError· class · Errores, avisos y reintentos
declare class CaptureOutOfOrderError extends ReplayErrorEmptyStepError· class · Errores, avisos y reintentos
declare class EmptyStepError extends ProtocolUsageErrorFlowUnsupportedError· class · Errores, avisos y reintentos
declare class FlowUnsupportedError extends ProtocolUsageErrorFrameRotatedError· class · Errores, avisos y reintentos
declare class FrameRotatedError extends ReplayErrorFramesEndedEarlyError· class · Errores, avisos y reintentos
declare class FramesEndedEarlyError extends ReplayErrorFramesOutOfOrderError· class · Errores, avisos y reintentos
declare class FramesOutOfOrderError extends ReplayErrorHttpError· class · Errores, avisos y reintentos
declare class HttpError extends ErrorKodecFailedError· class · Errores, avisos y reintentos
declare class KodecFailedError extends ReplayErrorManifestInvalidError· class · Errores, avisos y reintentos
declare class ManifestInvalidError extends ReplayErrorMediaUnknownError· class · Errores, avisos y reintentos
declare class MediaUnknownError extends ProtocolUsageErrorNoFacePrerollError· class · Errores, avisos y reintentos
declare class NoFacePrerollError extends ReplayErrorOwnAttemptProcessingError· class · Errores, avisos y reintentos
declare class OwnAttemptProcessingError extends ReplayErrorPositionBusyError· class · Errores, avisos y reintentos
declare class PositionBusyError extends ReplayErrorProtocolConflictError· class · Errores, avisos y reintentos
declare class ProtocolConflictError extends Error implements ProtocolErrorProtocolUsageError· class · Errores, avisos y reintentos
declare abstract class ProtocolUsageError extends ErrorReplayAbortedError· class · Errores, avisos y reintentos
declare class ReplayAbortedError extends ReplayErrorReplayError· class · Errores, avisos y reintentos
declare abstract class ReplayError extends ProtocolUsageErrorReplayPipelineError· class · Errores, avisos y reintentos
declare class ReplayPipelineError extends ReplayErrorSessionDirtyError· class · Errores, avisos y reintentos
declare class SessionDirtyError extends ProtocolUsageErrorSessionInvalidError· class · Errores, avisos y reintentos
declare class SessionInvalidError extends ProtocolUsageErrorStepSequenceError· class · Errores, avisos y reintentos
declare class StepSequenceError extends ProtocolUsageErrorTaxonomyInvalidError· class · Errores, avisos y reintentos
declare class TaxonomyInvalidError extends ProtocolUsageErrorUnknownOptionError· class · Errores, avisos y reintentos
declare class UnknownOptionError extends ProtocolUsageErrorUserBlockedError· class · Errores, avisos y reintentos
declare class UserBlockedError extends ReplayErrorUserGoneError· class · Errores, avisos y reintentos
declare class UserGoneError extends ReplayError
Interfaces
Sección titulada «Interfaces»CaptureQualitySummary· interface · HCIs y resultados
interface CaptureQualitySummary
miembros:capture·delegate·droppedTotal·fps·maxFps·minFps·windowsConflictDetail· interface · Errores, avisos y reintentos
interface ConflictDetail
miembros:captureId·capturedAt·earliestAt·expected·expired·goToPosition·hint·holder·latestAnalysedAt·raw·reason·ruleDeviceCheck· interface · En el dispositivo (tiempo real)
interface DeviceCheck
miembros:id·measured·reason·statusEngineToken· interface · En el dispositivo (tiempo real)
interface EngineToken
miembros:expiresAt·tokenFrameClockStats· interface · En el dispositivo (tiempo real)
interface FrameClockStats
miembros:head·iqr·max·mean·min·n·overflow·p25·p50·p75·saturated·slopeMsPerSec·tail·underflowManifestStep· interface · Steps y marcado
interface ManifestStep
miembros:endMediaMs·endedBy·mediaPid·order·startMediaMs·typeModeDecision· interface · En el dispositivo (tiempo real)
interface ModeDecision
miembros:by·mode·probeFps·reasonModelDownload· interface · En el dispositivo (tiempo real)
interface ModelDownload
miembros:files·filesDone·loadedBytes·totalBytes·totalKnownOwnReleaseError· interface · Errores, avisos y reintentos
interface OwnReleaseError
miembros:code·messagePositionHolder· interface · En el dispositivo (tiempo real)
interface PositionHolder
miembros:captureId·capturedAt·deferred·finished·receivingPackets·recordingEndedAtPreparedBlock· interface · En el dispositivo (tiempo real)
interface PreparedBlock
miembros:face·faceReloaded·level·origin·prepareId·speechProtocolError· interface · Errores, avisos y reintentos
interface ProtocolError
miembros:code·conflict·message·reason·recoverable·stepOrderProtocolResultEvent· interface · HCIs y resultados
interface ProtocolResultEvent
miembros:frameCount·hcis·hcisByStep·protocolMechanicId·raw·userProtocolIdProtocolWarningEvent· interface · Errores, avisos y reintentos
interface ProtocolWarningEvent
miembros:blocker·captureId·code·cut·fields·hci·message·messageKey·part·reason·stage·stepOrder·subStage·userMessageRecordingManifest· interface · Diferido (en servidor)
interface RecordingManifest
miembros:audioGaps·captureId·client·hidden·interpreted·orientation·orientationChanges·prerollMs·protocolMechanicId·recorder·recordingStartedAtMs·recordingStartedAtPrecisionMs·serverClockSkewMs·steps·stimulus·stopMediaMs·triggerAnalysis·userProtocolId·version·videoGapsReleaseOwnReservationConfig· interface · Servicio de procesado
interface ReleaseOwnReservationConfig
miembros:engineBaseUrl·getTokenReleaseOwnReservationResult· interface · Servicio de procesado
interface ReleaseOwnReservationResult
miembros:error·reason·releasedReleaseOwnReservationTarget· interface · Servicio de procesado
interface ReleaseOwnReservationTarget
miembros:captureId·protocolMechanicId·userProtocolIdReplayConfig· interface · Servicio de procesado
interface ReplayConfig
miembros:awaitInterpretation·engineBaseUrl·getToken·onError·onWarning·outcomeDeadlineMs·stepDeadlineMs·sttFlushDeadlineMs·taxonomy·tokenUrl·transcribeStepsReplayInput· interface · Servicio de procesado
interface ReplayInput
miembros:durationMs·frames·kodec·manifest·ptsOffsetMs·signal·transcriptReplayKodecOptions· interface · Servicio de procesado
interface ReplayKodecOptions
miembros:delegate·faceModel·visionUrl·wasmUrlReplayReport· interface · Servicio de procesado
interface ReplayReport
miembros:cost·origin·outsideSteps·steps·transcriptionReplayResult· interface · Servicio de procesado
interface ReplayResult
miembros:captureId·report·resultsReplaySegment· interface · Servicio de procesado
interface ReplaySegment
miembros:endMs·startMs·textReplayTranscript· interface · Servicio de procesado
interface ReplayTranscript
miembros:language·model·segmentsSessionReport· interface · HCIs y resultados
interface SessionReport
miembros:alignmentMisses·cancel·captureId·captureQuality·clock·codecErrors·correlationId·endedBy·finalGapWaitMs·framesBeforeFirstPacket·hiddenMs·interpretationMode·interpretationSource·kodecSessionId·modelDownload·replay·speech·startup·steps·streamDropsDuringWait·transcription·transcriptionLoad·transcriptionSetup·triggerAnalysisSpeechSlice· interface · En el dispositivo (tiempo real)
interface SpeechSlice
miembros:endMs·language·spokenMs·startMs·step·sttModel·textStartupReport· interface · En el dispositivo (tiempo real)
interface StartupReport
miembros:at·capture·context·cutBy·device·estimatedSpeechMs·kept·kind·kodecVersion·learned·level·mode·outcome·partialReason·prepared·schema·sdkVersion·seq·stages·startupId·totalMs·transcription·transcriptionGate·uaVersionToken·userAgentStartupStageRecord· interface · En el dispositivo (tiempo real)
interface StartupStageRecord
miembros:blocker·bytes·ms·parent·pending·reason·source·stage·status·totalStepTranscription· interface · En el dispositivo (tiempo real)
interface StepTranscription
miembros:cutsMaxLength·discarded·discardedAntiStuckMs·discardedMs·emitted·order·recoveredMs·retriedSplit·spokenMs·transcribed·typeStimulusSample· interface · Steps y marcado
interface StimulusSample
miembros:atMediaMs·event·stimulusTimeMsTaxonomy2· interface · En el dispositivo (tiempo real)
interface Taxonomy2
miembros:contextId·hciId·situationId·subcontextIdTranscriptionSetup· interface · En el dispositivo (tiempo real)
interface TranscriptionSetup
miembros:artifact·backend·deviceFellBackFrom·diarization·dtype·language·languageSource·model·modelReason·provisionalVetoLifted·sileroReady·usesWorker
ConflictReason· type · Errores, avisos y reintentos
type ConflictReason = (typeof CONFLICT_REASONS)[number];ConflictRule· type · Errores, avisos y reintentos
type ConflictRule = 'date_window' | 'time_of_day' | 'spacing' | 'start_order' | 'start_weekday';ConflictWarning· type · Errores, avisos y reintentos
type ConflictWarning = (typeof CONFLICT_WARNINGS)[number];DeviceCheckId· type · En el dispositivo (tiempo real)
type DeviceCheckId = 'secure-context' | 'get-user-media' | 'capture-route' | 'webgpu-adapter' | 'jspi' | 'wasm-simd' | 'audio-worklet' | 'storage-persisted' | 'media-recorder-mp4' | 'indexeddb' | 'storage-quota';HciMeans· type · HCIs y resultados
type HciMeans = Record<string, number>;InterpretationMode· type · En el dispositivo (tiempo real)
type InterpretationMode = 'engine' | 'stream';InterpretationSource· type · HCIs y resultados
type InterpretationSource = 'sse' | 'analyze-cache' | 'analyze-generated' | 'analyze' | 'stream';OwnReleaseReason· type · Errores, avisos y reintentos
type OwnReleaseReason = 'cancelled' | 'nothing-open' | 'not-ours' | 'not-sending' | 'check-failed' | 'cancel-failed';PartialReason· type · En el dispositivo (tiempo real)
type PartialReason = 'speech-timeout' | 'speech-error' | 'speech-unavailable' | 'speech-not-prepared' | 'speech-gate-timeout';PrepareLevel· type · En el dispositivo (tiempo real)
type PrepareLevel = 'memory' | 'cache';PreparedOrigin· type · En el dispositivo (tiempo real)
type PreparedOrigin = 'prepare' | 'previous-session';PreparedPartUse· type · En el dispositivo (tiempo real)
type PreparedPartUse = 'adopted' | 'stale' | 'unused' | 'not-prepared';ProtocolErrorCode· type · Errores, avisos y reintentos
type ProtocolErrorCode = 'E_HTTP' | 'E_RESULTS_TIMEOUT' | 'E_RESULTS_EMPTY' | 'E_INTERPRETATION_TIMEOUT' | 'E_ANALYSIS_IN_PROGRESS' | 'E_PROCESSING' | 'E_FRAMES_DISCARDED' | 'E_UPLOAD_FAILED' | 'E_STEP_LOST' | 'E_CAPTURE_LOST' | 'E_RECORDING_LOST' | 'E_AXES_MISSING' | 'E_NARRATIVE_REJECTED' | 'E_TAXONOMY_REJECTED' | 'E_TENANT_UNKNOWN' | 'E_ANALYSIS_FAILED' | 'E_CONFLICT';StartupFailReason· type · En el dispositivo (tiempo real)
type StartupFailReason = 'timeout' | 'network' | 'aborted' | 'refused' | 'unsupported' | 'error';StartupMessageKey· type · En el dispositivo (tiempo real)
type StartupMessageKey = 'startup.preparing' | 'face-model.running' | 'face-model.cached' | 'speech.running' | 'speech.stalled' | 'speech.timeout' | 'speech.unavailable' | 'face-model.stalled' | 'face-model.timeout' | 'face-model.error' | 'first-frame.timeout' | 'first-frame.timeout-media' | 'first-frame.face-reload-failed' | 'camera.timeout' | 'capture.aborted' | 'startup.ready' | 'prepare.speech-timeout' | 'prepare.speech-error' | 'prepare.aborted' | 'prepare.record-unsupported';StartupOutcome· type · En el dispositivo (tiempo real)
type StartupOutcome = 'ready' | 'partial' | 'failed' | 'aborted' | 'unfinished';StartupStage· type · En el dispositivo (tiempo real)
type StartupStage = 'engine-setup' | 'device' | 'camera' | 'face-model' | 'first-frame' | 'speech' | 'engine-session';StartupStagePending· type · En el dispositivo (tiempo real)
type StartupStagePending = 'provisional-video-veto' | 'another-load';StartupStageStatus· type · En el dispositivo (tiempo real)
type StartupStageStatus = 'pending' | 'running' | 'stalled' | 'done' | 'failed' | 'skipped';StartupSubStage· type · En el dispositivo (tiempo real)
type StartupSubStage = 'vision-runtime' | 'face-asset' | 'vision-create' | 'stt-library' | 'stt-weights' | 'stt-runtime' | 'stt-session' | 'vad';SttBlocker· type · En el dispositivo (tiempo real)
type SttBlocker = (typeof STT_BLOCKERS)[number];TokenProvider· type · En el dispositivo (tiempo real)
type TokenProvider = () => Promise<EngineToken>;TranscriptionCut· type · En el dispositivo (tiempo real)
type TranscriptionCut = unknown;
Constantes
Sección titulada «Constantes»CONFLICT_REASONS· const · Errores, avisos y reintentos
declare const CONFLICT_REASONS: readonly ["SESSION_ABANDONED", "POSITION_ALREADY_COMPLETED", "MECHANIC_EXPIRED", "MECHANIC_NOT_YET_AVAILABLE", "MUST_START_AT_FIRST_POSITION", "PROTOCOL_DEPRECATED", "POSITION_RESERVED", "CAPTURE_DISCARDED", "CAPTURE_OUT_OF_ORDER", "PROTOCOL_NOT_ANALYSED", "CAPTURE_CANCELLED"];CONFLICT_WARNINGS· const · Errores, avisos y reintentos
declare const CONFLICT_WARNINGS: readonly ["conflict.unknown-reason", "conflict.ambiguous-goto", "conflict.earliestAt-assumed-utc"];REPLAY_MAX_BUFFERED· const · Servicio de procesado
declare const REPLAY_MAX_BUFFERED = 600;REPLAY_OUTCOME_DEADLINE_MS· const · Servicio de procesado
declare const REPLAY_OUTCOME_DEADLINE_MS = 600000;REPLAY_STEP_DEADLINE_MS· const · Servicio de procesado
declare const REPLAY_STEP_DEADLINE_MS = 150000;STT_BLOCKERS· const · En el dispositivo (tiempo real)
declare const STT_BLOCKERS: readonly ["no-webgpu", "ladder-exhausted", "video-cost-veto", "no-memory-to-learn", "dtype-required"];
@neurologyca/capture-server
Sección titulada «@neurologyca/capture-server»Funciones
Sección titulada «Funciones»analyze· function · Los resultados en tu backend
declare function analyze(http: Http, ref: Pick<AnalysisRef, 'userProtocolId' | 'protocolMechanicId'>, opts?: AnalyzeOptions): Promise<AnalyzeResult>;analyzeForAudiences· function · Los resultados en tu backend
declare function analyzeForAudiences(http: Http, ref: AnalysisRef, audiences: readonly [string, ...string[]], opts?: AnalyzeForAudiencesOptions): Promise<AudienceReading[]>;assertServerEnvironment· function · Tu backend
declare function assertServerEnvironment(): void;buildTenantKit· function · sin guía
declare function buildTenantKit(http: Http, protocolPid: string, opts: BuildTenantKitOptions): Promise<TenantKit>;createEngineAdmin· function · Los resultados en tu backend
declare function createEngineAdmin(opts: CreateEngineAdminOptions): { createUser: (input: CreateUserInput) => Promise<AppUser>; updateUser: (externalId: string, input: UpdateUserInput) => Promise<void>; listUsers: (listOpts?: ListUsersOptions) => Promise<ListUsersResult>; deleteUser: (externalId: string) => Promise<DeleteUserResult>; listProtocolLibrary: () => Promise<ProtocolSummary[]>; enrol: (externalId: string, protocolPid: string, enrolOpts?: EnrolOptions) => Promise<{ userProtocolId: string; status: string; }>; listEnrolments: (externalId: string) => Promise<Enrolment[]>; getNextPosition: (userProtocolId: string) => Promise<NextPosition | null>; getResults: (ref: Pick<AnalysisRef, "userProtocolId" | "protocolMechanicId">) => Promise<GetResultsResult>; getProtocolResults: (ref: Pick<AnalysisRef, "userProtocolId">) => Promise<GetProtocolResultsResult>; listSessions: (ref: Pick<AnalysisRef, "userProtocolId" | "protocolMechanicId">) => Promise<unknown[]>; analyze: (ref: Pick<AnalysisRef, "userProtocolId" | "protocolMechanicId">, analyzeOpts?: AnalyzeOptions) => Promise<AnalyzeResult>; analyzeForAudiences: (ref: AnalysisRef, audiences: readonly [string, ...string[]], forOpts?: AnalyzeForAudiencesOptions) => Promise<AudienceReading[]>; buildTenantKit: (protocolPid: string, kitOpts?: Omit<BuildTenantKitOptions, "engineBase">) => Promise<TenantKit>; };createEngineProxy· function · Tu backend
declare function createEngineProxy(opts: CreateEngineProxyOptions): (req: Request) => Promise<Response>;createEnrolmentHandler· function · sin guía
declare function createEnrolmentHandler(opts: CreateEnrolmentHandlerOptions): (req: Request) => Promise<Response>;createHttp· function · Tu backend
declare function createHttp(opts: { baseUrl: string; apiKey: string; cache?: TokenCache; tokens?: TokenSource; fetch?: typeof fetch; }): { request(method: string, path: string, body?: unknown, reqOpts?: RequestOptions): Promise<unknown>; };createProcessorClient· function · Servicio de procesado
declare function createProcessorClient(opts: CreateProcessorClientOptions): ProcessorClient;createProcessorTokenHandler· function · Servicio de procesado
declare function createProcessorTokenHandler(opts: CreateProcessorTokenHandlerOptions): (req: Request) => Promise<Response>;createStartupReportReceiver· function · Tu backend
declare function createStartupReportReceiver(opts: CreateStartupReportReceiverOptions): StartupReportReceiver;createTokenHandler· function · Tu backend
declare function createTokenHandler(opts: CreateTokenHandlerOptions): (req: Request) => Promise<Response>;createTokenSource· function · Tu backend
declare function createTokenSource(opts: CreateTokenSourceOptions): TokenSource;createUploadReceiver· function · Tu backend
declare function createUploadReceiver(opts: CreateUploadReceiverOptions): UploadReceiver;createUser· function · Los resultados en tu backend
declare function createUser(http: Http, input: CreateUserInput): Promise<AppUser>;createWebhookHandler· function · Servicio de procesado
declare function createWebhookHandler(opts: CreateWebhookHandlerOptions): (req: Request) => Promise<Response>;deleteUser· function · Los resultados en tu backend
declare function deleteUser(http: Http, externalId: string): Promise<DeleteUserResult>;enrol· function · Los resultados en tu backend
declare function enrol(http: Http, externalId: string, protocolPid: string, opts?: EnrolOptions): Promise<{ userProtocolId: string; status: string; protocolNotice?: unknown; }>;getNextPosition· function · Los resultados en tu backend
declare function getNextPosition(http: Http, userProtocolId: string): Promise<NextPosition | null>;getProtocolResults· function · Los resultados en tu backend
declare function getProtocolResults(http: Http, ref: Pick<AnalysisRef, 'userProtocolId'>): Promise<GetProtocolResultsResult>;getResults· function · Los resultados en tu backend
declare function getResults(http: Http, ref: Pick<AnalysisRef, 'userProtocolId' | 'protocolMechanicId'>): Promise<GetResultsResult>;listEnrolments· function · Los resultados en tu backend
declare function listEnrolments(http: Http, externalId: string): Promise<Enrolment[]>;listProtocolLibrary· function · Los resultados en tu backend
declare function listProtocolLibrary(http: Http): Promise<ProtocolSummary[]>;listSessions· function · Los resultados en tu backend
declare function listSessions(http: Http, ref: Pick<AnalysisRef, 'userProtocolId' | 'protocolMechanicId'>): Promise<unknown[]>;listUsers· function · Los resultados en tu backend
declare function listUsers(http: Http, opts?: ListUsersOptions): Promise<ListUsersResult>;memoryNonceStore· function · Servicio de procesado
declare function memoryNonceStore(ttlMs?: number): NonceStore;ownsAll· function · Tu backend
declare function ownsAll(route: EngineRoute, checks: { userProtocol: (userProtocolId: string, protocolMechanicId: string | null) => Promise<boolean>; user: (userId: string) => Promise<boolean>; }): Promise<boolean>;proxyTimeoutMs· function · Tu backend
declare function proxyTimeoutMs(spec: EngineRouteSpec): number | null;readScoreIndex· function · HCIs y resultados
declare function readScoreIndex(structured: unknown, key?: ScoreIndexKey, opts?: ReadScoreIndexOptions): ScoreIndex | null;updateUser· function · Los resultados en tu backend
declare function updateUser(http: Http, externalId: string, input: UpdateUserInput): Promise<void>;validateNarrative· function · sin guía
declare function validateNarrative(n: NarrativeInput): NarrativeValidation;verifyProcessorSignature· function · Servicio de procesado
declare function verifyProcessorSignature(headers: Headers, rawBody: Uint8Array, secret: string, nonces: NonceStore, now: number, purpose: ProcessorPurpose): Promise<SignatureVerdict>;
EngineAdminError· class · Errores, avisos y reintentos
declare class EngineAdminError extends ErrorOnCompleteTimeoutError· class · Errores, avisos y reintentos
declare class OnCompleteTimeoutError extends ErrorProcessorError· class · Errores, avisos y reintentos
declare class ProcessorError extends ErrorUploadBusyError· class · Errores, avisos y reintentos
declare class UploadBusyError extends ErrorUploadStateError· class · Errores, avisos y reintentos
declare class UploadStateError extends ErrorUploadStorageError· class · Errores, avisos y reintentos
declare class UploadStorageError extends Error
Interfaces
Sección titulada «Interfaces»AnalysisRef· interface · Los resultados en tu backend
interface AnalysisRef
miembros:protocolMechanicId·userProtocolIdAnalyzeForAudiencesOptions· interface · Los resultados en tu backend
interface AnalyzeForAudiencesOptions
miembros:correlationId·onWarningAnalyzeOptions· interface · Los resultados en tu backend
interface AnalyzeOptions
miembros:audience·correlationId·onWarning·reAnalyzeAnalyzeResult· interface · Los resultados en tu backend
interface AnalyzeResult
miembros:audienceEvidence·audienceRequested·fromCache·inProgress·interpretation·keptPrevious·metadata·raw·reAnalyzed·retryAfterMs·structuredAppUser· interface · Los resultados en tu backend
interface AppUser
miembros:audience·createdAt·externalId·name·narrative·role·timezoneAudienceReading· interface · Los resultados en tu backend
interface AudienceReading
miembros:audience·fromCache·inProgress·interpretation·metadata·retryAfterMsBuildTenantKitOptions· interface · sin guía
interface BuildTenantKitOptions
miembros:engineBase·onWarning·proxyPathCorsOptions· interface · Tu backend
interface CorsOptions
miembros:credentials·headers·originsCreateEngineAdminOptions· interface · Los resultados en tu backend
interface CreateEngineAdminOptions
miembros:apiKey·baseUrl·cache·fetch·onWarning·tokensCreateEngineProxyOptions· interface · Tu backend
interface CreateEngineProxyOptions
miembros:authorize·baseUrl·cors·fetch·maxBodyBytes·mountPath·onError·tokensCreateEnrolmentHandlerOptions· interface · sin guía
interface CreateEnrolmentHandlerOptions
miembros:admin·getSessionUser·rateLimitCreateProcessorClientOptions· interface · Servicio de procesado
interface CreateProcessorClientOptions
miembros:apiKey·fetch·timeoutMs·urlCreateProcessorTokenHandlerOptions· interface · Servicio de procesado
interface CreateProcessorTokenHandlerOptions
miembros:authorize·captureToken·nonces·onError·secret·tokensCreateStartupReportReceiverOptions· interface · Tu backend
interface CreateStartupReportReceiverOptions
miembros:allowedOrigins·authorize·clientKey·maxBodyBytes·maxBytes·maxPerClientPerMinute·maxPerMinute·now·onError·retentionMs·storageCreateTokenHandlerOptions· interface · Tu backend
interface CreateTokenHandlerOptions
miembros:authorize·onError·tokensCreateTokenSourceOptions· interface · Tu backend
interface CreateTokenSourceOptions
miembros:apiKey·baseUrl·cache·fetch·mintTimeoutMs·refreshMarginMsCreateUploadReceiverOptions· interface · Tu backend
interface CreateUploadReceiverOptions
miembros:abandonedAfterMs·authorize·busyRetryAfterSec·checkManifest·checkManifestTimeoutMs·cors·leaseMs·lockWaitMs·maxBytes·maxOpenPerSubject·mountPath·notifyRetryAfterSec·onComplete·onCompleteTimeoutMs·onError·storage·tombstoneTtlMs·urlSecretCreateUserInput· interface · Los resultados en tu backend
interface CreateUserInput
miembros:allowNonUuidExternalId·audience·externalId·name·narrative·role·timezoneCreateWebhookHandlerOptions· interface · Servicio de procesado
interface CreateWebhookHandlerOptions
miembros:nonces·onError·onEvent·secretDeleteUserResult· interface · Los resultados en tu backend
interface DeleteUserResult
miembros:counts·deleted·tenantPidEngineAdmin· interface · Los resultados en tu backend
type EngineAdmin = ReturnType<typeof createEngineAdmin>;EngineRoute· interface · Tu backend
interface EngineRoute
miembros:method·name·protocolMechanicId·userId·userProtocolIdEngineRouteSpec· interface · Tu backend
interface EngineRouteSpec
miembros:body·idsFrom·method·name·stream·templateEnrolOptions· interface · Los resultados en tu backend
interface EnrolOptions
miembros:onWarningEnrolment· interface · Los resultados en tu backend
interface Enrolment
miembros:createdAt·progressPct·protocol·sessionsCompleted·status·totalSessions·userProtocolIdGetProtocolResultsResult· interface · Los resultados en tu backend
interface GetProtocolResultsResult
miembros:mechanicsGetResultsResult· interface · Los resultados en tu backend
interface GetResultsResult
miembros:aggResults·rawResults·speechHandlerErrorContext· interface · Tu backend
interface HandlerErrorContext
miembros:captureId·piece·routeKitGap· interface · sin guía
interface KitGap
miembros:candidates·field·whyListUsersOptions· interface · Los resultados en tu backend
interface ListUsersOptions
miembros:limitListUsersResult· interface · Los resultados en tu backend
interface ListUsersResult
miembros:total·usersListedUser· interface · Los resultados en tu backend
interface ListedUser
miembros:audience·blocked·blockedAt·createdAt·createdBy·externalId·name·protocolsAssigned·role·timezoneMechanicResults· interface · Los resultados en tu backend
interface MechanicResults extends GetResultsResult
miembros:order·protocolMechanicId·aggResults·rawResults·speechNarrativeInput· interface · Tu backend
interface NarrativeInput
miembros:depth·language·voiceNextPosition· interface · Los resultados en tu backend
interface NextPosition
miembros:mechanicName·order·protocolMechanicId·userProtocolIdNonceStore· interface · Servicio de procesado
interface NonceStore
miembros:seenProcessorCallOptions· interface · Servicio de procesado
interface ProcessorCallOptions
miembros:signalProcessorClient· interface · Servicio de procesado
interface ProcessorClient
miembros:getJob·retry·submitProcessorJob· interface · Servicio de procesado
interface ProcessorJob
miembros:attempt·captureId·errorCode·errorMessage·interimWebhook·interpretation·jobId·outcome·processor·report·retryable·status·waits·webhookProcessorJobTaxonomy· interface · Servicio de procesado
interface ProcessorJobTaxonomy
miembros:contextId·hciId·subcontextIdProcessorSubmit· interface · Servicio de procesado
interface ProcessorSubmit
miembros:engineBaseUrl·interimWebhook·language·manifest·taxonomy·tokenUrl·transcribeSteps·videoUrl·webhookUrlProcessorTokenRequest· interface · Servicio de procesado
interface ProcessorTokenRequest
miembros:captureId·jobId·protocolMechanicId·userProtocolIdProcessorWebhookDelivery· interface · Servicio de procesado
interface ProcessorWebhookDelivery
miembros:attempts·statusProcessorWebhookEvent· interface · Servicio de procesado
interface ProcessorWebhookEvent
miembros:captureId·deliveryId·errorCode·errorMessage·interpretation·jobId·outcome·processor·report·retryable·statusProtocolSummary· interface · Los resultados en tu backend
interface ProtocolSummary
miembros:group·interpreted·name·objective·pid·positions·statusReadScoreIndexOptions· interface · HCIs y resultados
interface ReadScoreIndexOptions
miembros:onWarning·onWarningScoreIndex· interface · HCIs y resultados
interface ScoreIndex
miembros:band·degradedSignals·indicatorsUsed·label·status·value·band·degradedSignals·indicatorsUsed·label·status·valueStartupReportReceiver· interface · Tu backend
interface StartupReportReceiver
miembros:handler·read·sweepStartupReportRecord· interface · Tu backend
interface StartupReportRecord
miembros:receivedAt·report·unvalidatedStartupReportStorage· interface · Tu backend
interface StartupReportStorage
miembros:append·bytes·read·sweepStepSpeech· interface · Los resultados en tu backend
interface StepSpeech
miembros:questionText·transcriptTenantConfigShape· interface · sin guía
interface TenantConfigShape
miembros:batchMs·engineBaseUrl·fps·taxonomy·transcribe·transcribeStepsTenantKit· interface · sin guía
interface TenantKit
miembros:config·env·kind·notices·pendingTokenCache· interface · Tu backend
interface TokenCache
miembros:get·setTokenSource· interface · Tu backend
interface TokenSource
miembros:get·invalidateUpdateUserInput· interface · Los resultados en tu backend
interface UpdateUserInput
miembros:audience·name·narrative·role·timezoneUploadLease· interface · Tu backend
interface UploadLease
miembros:release·renew·tokenUploadReceiver· interface · Tu backend
interface UploadReceiver
miembros:handler·manifest·markNotified·mediaHandler·notify·pendingNotifications·remove·signedUrl·sweepUploadState· interface · Tu backend
interface UploadState
miembros:bytes·committed·manifest·mimeType·notified·owner·size·touchedAtUploadStorage· interface · Tu backend
interface UploadStorage
miembros:append·commit·create·get·lease·list·markNotified·partBytes·presign·read·remove·sweepUploadTombstone· interface · Tu backend
interface UploadTombstone
miembros:expiresAt·removedAt
AdminErrorCode· type · Errores, avisos y reintentos
type AdminErrorCode = 'E_ROLE_UNKNOWN' | 'E_NARRATIVE_INVALID' | 'E_PROTOCOL_DRAFT' | 'E_PROTOCOL_UNKNOWN' | 'E_USER_EXISTS' | 'E_USER_UNKNOWN' | 'E_RATE_LIMITED' | 'E_ENGINE_HTTP' | 'E_MINT_TIMEOUT' | 'E_USER_BLOCKED' | 'E_CREDENTIAL_FORBIDDEN' | 'E_PROTOCOL_BASELINE' | 'E_CONTEXT_NOT_ASSIGNED' | 'E_USER_AMBIGUOUS' | 'E_PROTOCOL_STATE_CHANGED' | 'E_KIT_NO_CONTEXT' | 'E_KIT_TAXONOMY_UNREADABLE' | 'E_AUDIENCE_KEPT_PREVIOUS' | 'E_AUDIENCE_INVALID' | 'E_PROTOCOL_DEPRECATED' | 'E_CATALOGUE_NO_PID';EngineRouteName· type · Tu backend
type EngineRouteName = 'protocol' | 'plan' | 'sessions' | 'baseline-get' | 'baseline-post' | 'stream' | 'context' | 'query' | 'frames' | 'results' | 'analyze-stream' | 'analyze' | 'cancel';HandlerErrorHook· type · Tu backend
type HandlerErrorHook = (error: unknown, context: HandlerErrorContext) => void;NarrativeValidation· type · sin guía
type NarrativeValidation = { ok: true; } | { ok: false; field: string; got: string; allowed: string[]; };ProcessorInterpretation· type · Servicio de procesado
type ProcessorInterpretation = 'ready' | 'degraded' | 'failed' | 'timeout' | 'unknown' | 'not-requested';ProcessorJobStatus· type · Servicio de procesado
type ProcessorJobStatus = 'queued' | 'downloading' | 'preparing' | 'transcribing' | 'replaying' | 'waiting' | 'interpreting' | 'succeeded' | 'failed';ProcessorPurpose· type · Servicio de procesado
type ProcessorPurpose = 'webhook' | 'token';ProcessorWebhookStatus· type · Servicio de procesado
type ProcessorWebhookStatus = 'none' | 'pending' | 'delivered' | 'failed';ProxyCors· type · Tu backend
type ProxyCors = CorsOptions;ScoreIndexKey· type · HCIs y resultados
type ScoreIndexKey = 'wellness_index' | (string & {});ScoreIndexStatus· type · HCIs y resultados
type ScoreIndexStatus = 'ok' | 'degraded' | 'not_shown';SignatureVerdict· type · Servicio de procesado
type SignatureVerdict = { ok: true; } | { ok: false; reason: 'missing' | 'malformed' | 'stale' | 'bad-signature' | 'replayed'; };SpeechByStep· type · Los resultados en tu backend
type SpeechByStep = Record<string, StepSpeech>;UploadAppendResult· type · Tu backend
type UploadAppendResult = { ok: true; bytes: number; } | { ok: false; bytes: number | null; };UploadCreateResult· type · Tu backend
type UploadCreateResult = { ok: true; state: UploadState; } | { ok: false; reason: 'exists' | 'quota'; state?: UploadState | UploadTombstone; };UploadInit· type · Tu backend
type UploadInit = Omit<UploadState, 'bytes' | 'committed' | 'notified' | 'touchedAt'>;UploadStateCode· type · Tu backend
type UploadStateCode = 'E_NOT_FOUND' | 'E_UPLOAD_GONE' | 'E_NOT_COMMITTED';
Constantes
Sección titulada «Constantes»ANALYZE_TIMEOUT_MS· const · Los resultados en tu backend
declare const ANALYZE_TIMEOUT_MS = 300000;CLOCK_TOLERANCE_MS· const · Servicio de procesado
declare const CLOCK_TOLERANCE_MS = 300000;DEFAULT_NARRATIVE· const · Tu backend
declare const DEFAULT_NARRATIVE: { readonly voice: "third"; readonly depth: "professional"; readonly language: "en"; };ENGINE_ROUTES· const · Tu backend
declare const ENGINE_ROUTES: readonly EngineRouteSpec[];MEASUREMENT_CONTEXT_ID· const · sin guía
declare const MEASUREMENT_CONTEXT_ID = "measurement";NONCE_TTL_MS· const · Servicio de procesado
declare const NONCE_TTL_MS = 600000;PROCESSOR_ERROR_BODY_MAX_BYTES· const · Servicio de procesado
declare const PROCESSOR_ERROR_BODY_MAX_BYTES: number;PROCESSOR_TIMEOUT_MS· const · Servicio de procesado
declare const PROCESSOR_TIMEOUT_MS = 30000;PROXY_TIMEOUT_MS· const · Tu backend
declare const PROXY_TIMEOUT_MS = 120000;TOKEN_BODY_MAX· const · Tu backend
declare const TOKEN_BODY_MAX: number;TOKEN_CACHE_TIMEOUT_MS· const · Tu backend
declare const TOKEN_CACHE_TIMEOUT_MS = 2000;TOKEN_MINT_TIMEOUT_MS· const · Tu backend
declare const TOKEN_MINT_TIMEOUT_MS = 20000;WEBHOOK_BODY_MAX· const · Servicio de procesado
declare const WEBHOOK_BODY_MAX: number;
@neurologyca/capture-server/node
Sección titulada «@neurologyca/capture-server/node»Funciones
Sección titulada «Funciones»localDiskStartupReports· function · Tu backend
declare function localDiskStartupReports(opts: LocalDiskStartupReportsOptions): StartupReportStorage;localDiskStorage· function · Tu backend
declare function localDiskStorage(opts: LocalDiskStorageOptions): UploadStorage;toNodeListener· function · Tu backend
declare function toNodeListener(handler: (req: Request) => Promise<Response>): (req: IncomingMessage, res: ServerResponse, next?: (err?: unknown) => void) => void;
Interfaces
Sección titulada «Interfaces»LocalDiskStartupReportsOptions· interface · Tu backend
interface LocalDiskStartupReportsOptions
miembros:dir·maxFileBytesLocalDiskStorageOptions· interface · Tu backend
interface LocalDiskStorageOptions
miembros:dir·partBytes