Skip to main content

@neurosity/sdk

@neurosity/sdk

Index​

Enumerations​

Classes​

Interfaces​

Type aliases​

Object literals​

Type aliases​

AmplitudeByChannel​

Ƭ AmplitudeByChannel: number[][]

Defined in types/brainwaves.ts:7

AwarenessLabels​

Ƭ AwarenessLabels: "calm" | "focus"

Defined in types/awareness.ts:1

BandName​

Ƭ BandName: "gamma" | "beta" | "alpha" | "theta" | "delta"

Defined in types/brainwaves.ts:28

BrainwavesLabel​

Ƭ BrainwavesLabel: "raw" | "rawUnfiltered" | "powerByBand" | "psd"

Defined in types/brainwaves.ts:1

ChannelQuality​

Ƭ ChannelQuality: object

Defined in types/signalQuality.ts:1

Type declaration:​

  • standardDeviation: number

  • status: "great" | "good" | "bad" | "noContact"

Credentials​

Ƭ Credentials: EmailAndPassword | OAuthCredentials | CustomToken

Defined in types/credentials.ts:15

CustomToken​

Ƭ CustomToken: object

Defined in types/credentials.ts:1

Type declaration:​

  • customToken: string

DeviceSelector​

Ƭ DeviceSelector: DeviceSelectorKeyValue | DeviceSelectorFunction

Defined in types/deviceInfo.ts:21

DeviceSelectorFunction​

Ƭ DeviceSelectorFunction: function

Defined in types/deviceInfo.ts:19

Type declaration:​

▸ (devices: DeviceInfo[]): DeviceInfo

Parameters:

NameType
devicesDeviceInfo[]

DeviceSelectorKeyValue​

Ƭ DeviceSelectorKeyValue: []

Defined in types/deviceInfo.ts:18

EmailAndPassword​

Ƭ EmailAndPassword: object

Defined in types/credentials.ts:5

Type declaration:​

  • email: string

  • password: string

Experiment​

Ƭ Experiment: object

Defined in types/experiment.ts:1

Type declaration:​

  • deviceId: string

  • id: string

  • labels: string[]

  • name: string

  • timestamp: number

  • totalTrials: number

  • userId: string

HapticEffects​

Ƭ HapticEffects: object

Defined in types/hapticEffects.ts:1

Type declaration:​

  • alert1000ms: string

  • alert750ms: string

  • buzz1_100: string

  • buzz2_80: string

  • buzz3_60: string

  • buzz4_40: string

  • buzz5_20: string

  • doubleClick100: string

  • doubleClick60: string

  • longBuzzForProgrammaticStopping_100: string

  • longDoubleSharpClickMedium1_100: string

  • longDoubleSharpClickMedium2_80: string

  • longDoubleSharpClickMedium3_60: string

  • longDoubleSharpClickStrong1_100: string

  • longDoubleSharpClickStrong2_80: string

  • longDoubleSharpClickStrong3_60: string

  • longDoubleSharpClickStrong4_30: string

  • longDoubleSharpTick1_100: string

  • longDoubleSharpTick2_80: string

  • longDoubleSharpTick3_60: string

  • mediumClick1_100: string

  • mediumClick2_80: string

  • mediumClick3_60: string

  • pulsingMedium1_100: string

  • pulsingMedium2_60: string

  • pulsingSharp1_100: string

  • pulsingSharp2_60: string

  • pulsingStong1_100: string

  • pulsingStong2_60: string

  • sharpClick100: string

  • sharpClick30: string

  • sharpClick60: string

  • sharpTick1_100: string

  • sharpTick2_80: string

  • sharpTick3_60: string

  • shortDoubleClickMedium1_100: string

  • shortDoubleClickMedium2_80: string

  • shortDoubleClickMedium3_60: string

  • shortDoubleClickStrong1_100: string

  • shortDoubleClickStrong2_80: string

  • shortDoubleClickStrong3_60: string

  • shortDoubleClickStrong4_30: string

  • shortDoubleSharpTick1_100: string

  • shortDoubleSharpTick2_80: string

  • shortDoubleSharpTick3_60: string

  • smoothHum1_50: string

  • smoothHum2_40: string

  • smoothHum3_30: string

  • smoothHum4_20: string

  • smoothHum5_10: string

  • softBump100: string

  • softBump30: string

  • softBump60: string

  • softFuzz60: string

  • strongBuzz100: string

  • strongClick100: string

  • strongClick1_100: string

  • strongClick2_80: string

  • strongClick30: string

  • strongClick3_60: string

  • strongClick4_30: string

  • strongClick60: string

  • transistionClick1_100: string

  • transistionClick2_80: string

  • transistionClick3_60: string

  • transistionClick4_40: string

  • transistionClick5_20: string

  • transistionClick6_10: string

  • transistionHum1_100: string

  • transistionHum2_80: string

  • transistionHum3_60: string

  • transistionHum4_40: string

  • transistionHum5_20: string

  • transistionHum6_10: string

  • transitionRampDownLongMedium1_100_to_0: string

  • transitionRampDownLongMedium2_100_to_0: string

  • transitionRampDownLongSharp1_100_to_0: string

  • transitionRampDownLongSharp1_50_to_0: string

  • transitionRampDownLongSharp2_100_to_0: string

  • transitionRampDownLongSharp2_50_to_0: string

  • transitionRampDownLongSmooth1_100_to_0: string

  • transitionRampDownLongSmooth1_50_to_0: string

  • transitionRampDownLongSmooth2_100_to_0: string

  • transitionRampDownLongSmooth2_50_to_0: string

  • transitionRampDownMediumSharp1_50_to_0: string

  • transitionRampDownMediumSharp2_50_to_0: string

  • transitionRampDownMediumSmooth1_100_to_0: string

  • transitionRampDownMediumSmooth1_50_to_0: string

  • transitionRampDownMediumSmooth2_100_to_0: string

  • transitionRampDownMediumSmooth2_50_to_0: string

  • transitionRampDownShortSharp1_100_to_0: string

  • transitionRampDownShortSharp1_50_to_0: string

  • transitionRampDownShortSharp2_100_to_0: string

  • transitionRampDownShortSharp2_50_to_0: string

  • transitionRampDownShortSmooth1_100_to_0: string

  • transitionRampDownShortSmooth1_50_to_0: string

  • transitionRampDownShortSmooth2_100_to_0: string

  • transitionRampDownShortSmooth2_50_to_0: string

  • transitionRampUpLongSharp1_0_to_100: string

  • transitionRampUpLongSharp1_0_to_50: string

  • transitionRampUpLongSharp2_0_to_100: string

  • transitionRampUpLongSharp2_0_to_50: string

  • transitionRampUpLongSmooth1_0_to_100: string

  • transitionRampUpLongSmooth1_0_to_50: string

  • transitionRampUpLongSmooth2_0_to_100: string

  • transitionRampUpLongSmooth2_0_to_50: string

  • transitionRampUpMediumSharp1_0_to_100: string

  • transitionRampUpMediumSharp1_0_to_50: string

  • transitionRampUpMediumSharp2_0_to_100: string

  • transitionRampUpMediumSharp2_0_to_50: string

  • transitionRampUpMediumSmooth1_0_to_100: string

  • transitionRampUpMediumSmooth1_0_to_50: string

  • transitionRampUpMediumSmooth2_0_to_100: string

  • transitionRampUpMediumSmooth2_0_to_50: string

  • transitionRampUpShortSharp1_0_to_100: string

  • transitionRampUpShortSharp1_0_to_50: string

  • transitionRampUpShortSharp2_0_to_100: string

  • transitionRampUpShortSharp2_0_to_50: string

  • transitionRampUpShortSmooth1_0_to_100: string

  • transitionRampUpShortSmooth1_0_to_50: string

  • transitionRampUpShortSmooth2_0_to_100: string

  • transitionRampUpShortSmooth2_0_to_50: string

  • tripleClick100: string

OAuthConfig​

Ƭ OAuthConfig: object

Defined in types/oauth.ts:1

Type declaration:​

  • clientId: string

  • clientSecret? : string

  • redirectUri: string

  • responseType: "token" | "code"

  • scope: string[]

  • state: string

OAuthCredentials​

Ƭ OAuthCredentials: object

Defined in types/credentials.ts:10

Type declaration:​

  • idToken: string

  • providerId: string

OAuthQuery​

Ƭ OAuthQuery: object

Defined in types/oauth.ts:10

Type declaration:​

  • clientId: string

  • clientSecret: string

  • userId: string

OAuthQueryResult​

Ƭ OAuthQueryResult: object

Defined in types/oauth.ts:16

Type declaration:​

  • customToken: string

  • userId: string

OAuthRemoveResponse​

Ƭ OAuthRemoveResponse: object

Defined in types/oauth.ts:21

Type declaration:​

  • ok: boolean

OSVersion​

Ƭ OSVersion: string

Defined in types/deviceInfo.ts:1

PSDByChannel​

Ƭ PSDByChannel: number[][]

Defined in types/brainwaves.ts:17

UserDevice​

Ƭ UserDevice: object

Defined in types/user.ts:1

Type declaration:​

  • claimedOn: number

UserDevices​

Ƭ UserDevices: object

Defined in types/user.ts:5

Type declaration:​

Object literals​

Const defaultOptions​

▪ defaultOptions: object​

Defined in Neurosity.ts:42

autoSelectDevice​

• autoSelectDevice: boolean = true

Defined in Neurosity.ts:44

emulator​

• emulator: boolean = false

Defined in Neurosity.ts:46

emulatorAuthPort​

• emulatorAuthPort: number = 9099

Defined in Neurosity.ts:48

emulatorDatabasePort​

• emulatorDatabasePort: number = 9000

Defined in Neurosity.ts:49

emulatorFirestorePort​

• emulatorFirestorePort: number = 8080

Defined in Neurosity.ts:51

emulatorFunctionsPort​

• emulatorFunctionsPort: number = 5001

Defined in Neurosity.ts:50

emulatorHost​

• emulatorHost: string = "localhost"

Defined in Neurosity.ts:47

emulatorOptions​

• emulatorOptions: object

Defined in Neurosity.ts:52

Type declaration:​

streamingMode​

• streamingMode: STREAMING_MODE = STREAMING_MODE.WIFI_ONLY

Defined in Neurosity.ts:45

timesync​

• timesync: boolean = false

Defined in Neurosity.ts:43