Measurement | Anura Web Core SDK

Properties

`Readonly`on

on: {
    afterRESTCall:
        | null
        | (
            timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
            actionId: number,
            status: string,
            error: unknown,
        ) => void;
    beforeRESTCall:
        | null
        | (
            timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
            actionId: number,
        ) => void;
    bytesDownloaded:
        | null
        | (
            bytes: number,
            uncompressedSize: number,
            url: string,
            done: boolean,
        ) => void;
    chunkSent: null | (chunkSent: ChunkSent) => void;
    constraintsUpdated:
        | null
        | (feedback: ConstraintFeedback, status: ConstraintStatus) => void;
    error: null | (category: ErrorCategories, data: unknown) => void;
    faceTrackerStateChanged: null | (state: FaceTrackerState) => void;
    facialLandmarksUpdated: null | (drawables: Drawables) => void;
    mediaElementResize: null | (event: MediaElementResizeEvent) => void;
    resultsReceived: null | (results: Results) => void;
} = ...

Type declaration

afterRESTCall:
    | null
    | (
        timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
        actionId: number,
        status: string,
        error: unknown,
    ) => void
after REST call

Param: timestamp
timestamp of the event

Param: status
HTTP status code

Param: error
error object
beforeRESTCall:
    | null
    | (
        timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
        actionId: number,
    ) => void
before REST call

Param: timestamp
timestamp of the event
bytesDownloaded:
    | null
    | (
        bytes: number,
        uncompressedSize: number,
        url: string,
        done: boolean,
    ) => void
bytes downloaded

Param: bytes
number of bytes downloaded

Param: uncompressedSize
uncompressed size of the file

Param: url
download URL

Param: done
true if download is complete

Note: If server-side compression is enabled, then you're comparing the downloaded byte count (from the network stream) to the uncompressed file size which is not reliable.
chunkSent: null | (chunkSent: ChunkSent) => void
When a chunk is sent to DeepAffex

Param: ChunkSent
constraintsUpdated: null | (feedback: ConstraintFeedback, status: ConstraintStatus) => void
when measurement results are received

Param: results
measurement results
error: null | (category: ErrorCategories, data: unknown) => void
When an error occurs

Param: category
error category

Param: data
error data
faceTrackerStateChanged: null | (state: FaceTrackerState) => void
when face tracker state Changes

Param: state
face tracker state
facialLandmarksUpdated: null | (drawables: Drawables) => void
When facial landmarks are updated

Param: Drawables
mediaElementResize: null | (event: MediaElementResizeEvent) => void
When media element size changes

Param: MediaElementResizeEvent
resultsReceived: null | (results: Results) => void
when measurement results are received

Param: results
measurement results

`Static`VERSION

VERSION: string = version

Methods

destroy

destroy(): Promise<void>
Returns Promise<void>

disconnect

disconnect(): Promise<void>
Disconnect from the Web Socket if the measurement is started

Returns Promise<void>

downloadAssets

downloadAssets(): Promise<undefined | boolean>
Check if SIMD is supported and then download the supported MediaPipe face traker assets for the runtime environment It also downloads the extraction lib assets

Returns Promise<undefined | boolean>
true if successfully download all files

getVersion

getVersion(): SDKVersion
Returns version number

Returns SDKVersion
version - [Web SDK, DFX Extraction Lib, Face Tracker]

loadMask

loadMask(element: SVGSVGElement): void
Parameters
- element: SVGSVGElement
Returns void

prepare

prepare(
    token: string,
    refreshToken: string,
    studyId: string,
    sdkId?: string,
): Promise<boolean>
Parameters
- token: string
- refreshToken: string
- studyId: string
- OptionalsdkId: string
Returns Promise<boolean>

reset

reset(): Promise<boolean>
Reset only if the face tracker is ready and tracking

Returns Promise<boolean>
true if the reset was successful, false otherwise

setConstraintsConfig

setConstraintsConfig(override: boolean): Promise<void>
Parameters
- override: boolean
Returns Promise<void>

setDemographics

setDemographics(demographics: Demographics): boolean
Set demographics
Parameters
- demographics: Demographics
  Demographics object
Returns boolean
true if demographics are valid and set, false otherwise

setExtractionLibSettings

setExtractionLibSettings(
    numberofChunks?: number,
    targetFPS?: number,
    chunkDurationSeconds?: number,
): void
Set extraction library settings
Parameters
- numberofChunks: number = 6
  Number of chunks for extraction library collector
- targetFPS: number = 30
  Target FPS for extraction library collector
- chunkDurationSeconds: number = 5
  Chunk duration in seconds for extraction library collector
Returns void

setMediaStream

setMediaStream(mediaStream: MediaStream): Promise<void>
Parameters
- mediaStream: MediaStream
Returns Promise<void>

setNextChunkAsFinal

setNextChunkAsFinal(): Promise<void>
Set the action for the next chunk to LAST::PROCESS

Returns Promise<void>

setObjectFit

setObjectFit(fit: ObjectFit): boolean
Parameters
- fit: ObjectFit
Returns boolean

setSettings

setSettings(newSettings: Partial<Settings>): boolean
Set settings
Parameters
- newSettings: Partial<Settings>
Returns boolean
true if success

startMeasurement

startMeasurement(
overrideConstraints?: boolean,
measurementOptions?: MeasurementOptions,
): Promise<string>
Start measurement by obtaining a measurement ID, resetting the collection, setting number of chunks and constraints config, setting demographics, starting collection, and connecting to the Web Socket if user token is available.

Returns the measurement ID.
Parameters
- overrideConstraints: boolean = false
- measurementOptions: MeasurementOptions = {}
Returns Promise<string>

startTracking

startTracking(): Promise<void>
Returns Promise<void>

stopTracking

stopTracking(): Promise<void>
Stop Face Tracker tracking frames and DFX extraction library collection If the measurement is started, it will disconnect from the Web Socket as well.

Returns Promise<void>

`Static`init

init(settings: Settings): Promise<Measurement>
Initialize the Measurement SDK
Parameters
- settings: Settings
  Initialization settings
Returns Promise<Measurement>
Promise

Properties

Readonlyon

Type declaration

afterRESTCall: | null | ( timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, actionId: number, status: string, error: unknown, ) => void

Param: timestamp

Param: status

Param: error

beforeRESTCall: | null | ( timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`, actionId: number, ) => void

Param: timestamp

bytesDownloaded: | null | ( bytes: number, uncompressedSize: number, url: string, done: boolean, ) => void

Param: bytes

Param: uncompressedSize

Param: url

Param: done

chunkSent: null | (chunkSent: ChunkSent) => void

Param: ChunkSent

constraintsUpdated: null | (feedback: ConstraintFeedback, status: ConstraintStatus) => void

Param: results

error: null | (category: ErrorCategories, data: unknown) => void

Param: category

Param: data

faceTrackerStateChanged: null | (state: FaceTrackerState) => void

Param: state

facialLandmarksUpdated: null | (drawables: Drawables) => void

Param: Drawables

mediaElementResize: null | (event: MediaElementResizeEvent) => void

Param: MediaElementResizeEvent

resultsReceived: null | (results: Results) => void

Param: results

StaticVERSION

Methods

destroy

Returns Promise<void>

disconnect

Returns Promise<void>

downloadAssets

Returns Promise<undefined | boolean>

getVersion

Returns SDKVersion

loadMask

Parameters

Returns void

prepare

Parameters

Returns Promise<boolean>

reset

Returns Promise<boolean>

setConstraintsConfig

Parameters

Returns Promise<void>

setDemographics

Parameters

Returns boolean

setExtractionLibSettings

Parameters

Returns void

setMediaStream

Parameters

Returns Promise<void>

setNextChunkAsFinal

Returns Promise<void>

setObjectFit

Parameters

Returns boolean

setSettings

Parameters

Returns boolean

startMeasurement

Parameters

Returns Promise<string>

startTracking

Returns Promise<void>

stopTracking

Returns Promise<void>

Staticinit

Parameters

Returns Promise<Measurement>

Settings

On This Page

`Readonly`on

afterRESTCall:
| null
| (
timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
actionId: number,
status: string,
error: unknown,
) => void

beforeRESTCall:
| null
| (
timestamp: `${number}-${number}-${number}T${number}:${number}:${number}.${number}Z`,
actionId: number,
) => void

bytesDownloaded:
| null
| (
bytes: number,
uncompressedSize: number,
url: string,
done: boolean,
) => void

`Static`VERSION

`Static`init