Options
All
  • Public
  • Public/Protected
  • All
Menu

@formant/data-sdk

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AccessLevel

AccessLevel: typeof accessLevels[number]

AggregateLevel

AggregateLevel: "year" | "month" | "week" | "day" | "hour" | "minute" | "second"

AnnotationAreaType

AnnotationAreaType: keyof IAnnotationAreaTypeMap

AnnotationType

AnnotationType: keyof IFieldParametersTypeMap

AppMessage

AppMessage: { time: number; type: "go_to_time" } | { deviceId: string; type: "go_to_device" } | { module: string; type: "request_module_data" } | { message: string; type: "show_message" } | { module: string; type: "refresh_auth_token" } | { after: number; before: number; module: string; type: "set_module_data_time_range" } | { menus: { label: string }[]; module: string; type: "setup_module_menus" } | { channel: string; data: any; source: string; type: "send_channel_data" } | { type: "request_devices" }

DataChannelBinaryListener

DataChannelBinaryListener: ((message: Uint8Array) => void)

Type declaration

    • (message: Uint8Array): void

    • Parameters

      • message: Uint8Array

      Returns void

DataChannelErrorListener

DataChannelErrorListener: ((ev: Event) => void)

Type declaration

    • (ev: Event): void

    • Parameters

      • ev: Event

      Returns void

DataChannelListener

DataChannelListener: (() => void)

Type declaration

    • (): void

    • Returns void

DataChannelStringListener

DataChannelStringListener: ((message: string) => void)

Type declaration

    • (message: string): void

    • Parameters

      • message: string

      Returns void

DataPoint

DataPoint: [number, any]

EmbeddedAppMessage

EmbeddedAppMessage: { menu: string; type: "module_menu_item_clicked" } | { token: string; type: "auth_token" } | { queryRange: { end: number; start: number }; streams: {}; time: number; type: "module_data" } | { channel: string; data: any; source: string; type: "channel_data" } | ModuleConfigurationMessage

EventSortableColumn

EventSortableColumn: "device.name" | "time"

EventType

EventType: typeof eventTypes[number]

HealthStatus

HealthStatus: typeof healthStatuses[number]

HexRgbColor

HexRgbColor: string

IDataAggregate

IDataAggregate<T>: [Timestamp, IStreamAggregateTypeMap[T]]

Type Parameters

IDataPoint

IDataPoint<T>: [Timestamp, IStreamTypeMap[T]]

Type Parameters

IEvent

IEvent: ITriggeredEvent | IInterventionRequest | ITeleopSessionRecord | IPortForwardingSessionRecord | ICommandRequestEvent | ICommandResponseEvent | ICommandDeliveryEvent | ICustomEvent | IComment | ISystemEvent | IAnnotation

INumericSetAggregateMap

INumericSetAggregateMap: Map<string, { unit?: string; value: INumericAggregate }>

IStreamAggregateTypeMap

IStreamAggregateTypeMap: Omit<{ [ _ in StreamType]: undefined }, keyof ISupportedStreamAggregateTypeMap> & ISupportedStreamAggregateTypeMap

InterventionType

InterventionType: keyof IInterventionTypeMap

IsoDate

IsoDate: string

ModuleConfigurationMessage

ModuleConfigurationMessage: { configuration: string; temporary: boolean; type: "module_configuration" }

Type declaration

  • configuration: string
  • temporary: boolean
  • type: "module_configuration"

RealtimeAudioStream

RealtimeAudioStream: { name: string }

Type declaration

  • name: string

RealtimeDataStream

RealtimeDataStream: { name: string }

Type declaration

  • name: string

RealtimeListener

RealtimeListener: ((peerId: string, message: RealtimeMessage) => void)

Type declaration

RealtimeManipulatorConfig

RealtimeManipulatorConfig: { baseReferenceFrame?: string; currentJointStateStream: RealtimeDataStream; endEffectorLinkName?: string; endEffectorStream?: RealtimeDataStream; localFrame?: string; planValidStream?: RealtimeDataStream; plannedJointStateStream?: RealtimeDataStream }

Type declaration

RealtimeMessage

RealtimeMessage: { header: { created: number; stream: { entityId: string; streamName: string; streamType: RtcStreamType } }; payload: IRtcStreamPayload }

Type declaration

  • header: { created: number; stream: { entityId: string; streamName: string; streamType: RtcStreamType } }
    • created: number
    • stream: { entityId: string; streamName: string; streamType: RtcStreamType }
      • entityId: string
      • streamName: string
      • streamType: RtcStreamType
  • payload: IRtcStreamPayload

RealtimeVideoStream

RealtimeVideoStream: { name: string }

Type declaration

  • name: string

Severity

Severity: typeof severities[number]

SortOrder

SortOrder: "asc" | "desc"

StreamType

StreamType: keyof IStreamTypeMap

Timestamp

Timestamp: number

Uuid

Uuid: string

VideoMimeType

VideoMimeType: typeof videoMimeTypes[number]

Variables

Const SessionType

SessionType: { Observe: number; Teleop: number } = ...

Type declaration

  • Observe: number
  • Teleop: number

Const accessLevels

accessLevels: readonly ["viewer", "operator", "administrator"] = ...

Const administrator

administrator: "viewer" | "operator" | "administrator" = ...

Const aggregateFunctionMap

aggregateFunctionMap: { average: ((a: INumericAggregate) => number); count: ((a: INumericAggregate) => number); max: ((a: INumericAggregate) => number); min: ((a: INumericAggregate) => number); standard deviation: ((a: INumericAggregate) => number); sum: ((a: INumericAggregate) => number) } = ...

Type declaration

Const aggregateLevels

aggregateLevels: AggregateLevel[] = ...

Const annotationTypes

annotationTypes: string[] = ...

Const eventTypes

eventTypes: readonly ["triggered-event", "intervention-request", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation"] = ...

Const healthStatuses

healthStatuses: readonly ["unknown", "operational", "offline", "error"] = ...

Const interventionTypes

interventionTypes: string[] = ...

Const operator

operator: "viewer" | "operator" | "administrator" = ...

Const severities

severities: readonly ["info", "warning", "error", "critical"] = ...

Const videoMimeTypes

videoMimeTypes: readonly ["video/mp4"] = ...

Const viewer

viewer: "viewer" | "operator" | "administrator" = ...

Functions

combineNumericAggregates

combineNumericSetAggregates

  • combineNumericSetAggregates(e1: WireINumericSetAggregateMap, e2: WireINumericSetAggregateMap): WireINumericSetAggregateMap

getAverage

getCount

getMax

getMin

getStandardDeviation

getSum

getVariance

getZeroINumericSet

  • getZeroINumericSet(): { count: number; max: number; min: number; sum: number; sumOfSquares: number }

  • Returns { count: number; max: number; min: number; sum: number; sumOfSquares: number }

    • count: number
    • max: number
    • min: number
    • sum: number
    • sumOfSquares: number

reduceNumericSetStreamAggregates

reduceNumericStreamAggregates

Generated using TypeDoc