Options
All
  • Public
  • Public/Protected
  • All
Menu

@formant/data-sdk

Index

Classes

Interfaces

Type Aliases

Variables

Type Aliases

AccessLevel: typeof accessLevels[number]
AggregateLevel: "year" | "month" | "week" | "day" | "hour" | "minute" | "second"
AnnotationAreaType: keyof IAnnotationAreaTypeMap
AnnotationType: keyof IFieldParametersTypeMap
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" }
DataChannelBinaryListener: ((message: Uint8Array) => void)

Type declaration

    • (message: Uint8Array): void
    • Parameters

      • message: Uint8Array

      Returns void

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

Type declaration

    • (ev: Event): void
    • Parameters

      • ev: Event

      Returns void

DataChannelListener: (() => void)

Type declaration

    • (): void
    • Returns void

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

Type declaration

    • (message: string): void
    • Parameters

      • message: string

      Returns void

DataPoint: [number, any]
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" }
EventSortableColumn: "device.name" | "time"
EventType: typeof eventTypes[number]
HealthStatus: typeof healthStatuses[number]
HexRgbColor: string
IDataPoint<T>: [Timestamp, IStreamTypeMap[T]]

Type Parameters

InterventionType: keyof IInterventionTypeMap
IsoDate: string
RealtimeDataStream: { name: string }

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

  • name: string
Severity: typeof severities[number]
SortOrder: "asc" | "desc"
StreamType: keyof IStreamTypeMap
Timestamp: number
Uuid: string
VideoMimeType: typeof videoMimeTypes[number]

Variables

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

Type declaration

  • Observe: number
  • Teleop: number
accessLevels: readonly ["viewer", "operator", "administrator"] = ...
administrator: "viewer" | "operator" | "administrator" = ...
aggregateLevels: AggregateLevel[] = ...
annotationTypes: string[] = ...
eventTypes: readonly ["triggered-event", "intervention-request", "teleop-session-record", "port-forwarding-session-record", "command-request", "command-response", "command-delivery", "custom", "comment", "system", "annotation"] = ...
healthStatuses: readonly ["unknown", "operational", "offline", "error"] = ...
interventionTypes: string[] = ...
operator: "viewer" | "operator" | "administrator" = ...
severities: readonly ["info", "warning", "error", "critical"] = ...
videoMimeTypes: readonly ["video/mp4"] = ...
viewer: "viewer" | "operator" | "administrator" = ...

Generated using TypeDoc