Class LiveUniverseData

Hierarchy (view full)

BasicUniverseDataConnector
- LiveUniverseData

Implements

IUniverseData

Index

Constructors

Properties

dataFetchWorkerPool dataFetchWorkerPoolOccupancy lastQueriedHistoricTime mapRealtimeConnections pcdWorkerPool pcdWorkerPoolOccupancy queryStore subscriberDistributorsLoaders subscriberLoaders subscriberSources time timeChangeListeners

Methods

addInteraction addInteractionListener addInteractionsChangedListener addRemovableTelemetrySubscription clearWorkerPool createH264Drawer createRealtimeConnection fetchImage getAvailableDataFetchWorker getAvailablePCDWorker getDeviceContextName getDeviceContexts getHardwareStreams getInteractions getLatestLocations getLatestTransformTrees getRealtimeButtons getStatistics getTelemetryStreamType getTelemetryStreams getTeleopRosStreams getUrdfs releaseDataFetchWorker releasePCDWorker removeInteraction sendCommand sendRealtimeBitset sendRealtimeBoolean sendRealtimePose sendRtcMessage setTime subcribeToVideo subscribeDataSourceStateChange subscribeToBitset subscribeToGeometry subscribeToGridMap subscribeToImage subscribeToJointState subscribeToJson subscribeToLocation subscribeToNumeric subscribeToNumericSet subscribeToOdometry subscribeToPath subscribeToPointCloud subscribeToPose subscribeToRealtimeMessages subscribeToText subscribeToTransformTree subscribeToVideo unsubscribeToRealtimeMessages

Constructors

constructor

new LiveUniverseData(): LiveUniverseData
Returns LiveUniverseData
Overrides BasicUniverseDataConnector.constructor
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:37

Properties

dataFetchWorkerPool

dataFetchWorkerPool: Worker[] = []

dataFetchWorkerPoolOccupancy

dataFetchWorkerPoolOccupancy: Boolean[] = ...

lastQueriedHistoricTime

lastQueriedHistoricTime: undefined | Date

mapRealtimeConnections

mapRealtimeConnections: Map<string, "loading" | Device | PeerDevice> = ...

pcdWorkerPool

pcdWorkerPool: Worker[] = []

pcdWorkerPoolOccupancy

pcdWorkerPoolOccupancy: Boolean[] = ...

queryStore

queryStore: QueryStore = ...

subscriberDistributorsLoaders

subscriberDistributorsLoaders: Map<string, Map<string, ((data) => void)[]>> = ...

subscriberLoaders

subscriberLoaders: Map<string, Map<string, ((data) => Promise<DataResult<any>>)>> = ...

subscriberSources

subscriberSources: Map<string, Map<string, UniverseDataSource>> = ...

time

time: Date | "live"

timeChangeListeners

timeChangeListeners: ((time) => void)[] = []

Type declaration

- (time): void
- Parameters
  - time: Date | "live"
  Returns void

Methods

addInteraction

addInteraction(_interaction): void
Parameters
- _interaction: Interaction
Returns void
Implementation of IUniverseData.addInteraction
Inherited from BasicUniverseDataConnector.addInteraction
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:431

addInteractionListener

addInteractionListener(_callback): (() => void)
Parameters
- _callback: ((interaction) => void)
  - - (interaction): void
    - Parameters
      interaction: Interaction
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.addInteractionListener
Inherited from BasicUniverseDataConnector.addInteractionListener
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:449

addInteractionsChangedListener

addInteractionsChangedListener(_callback): (() => void)
Parameters
- _callback: ((interactions) => void)
  - - (interactions): void
    - Parameters
      interactions: Interaction[]
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.addInteractionsChangedListener
Inherited from BasicUniverseDataConnector.addInteractionsChangedListener
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:443

`Protected` addRemovableTelemetrySubscription

addRemovableTelemetrySubscription<T>(deviceId, source, loader, distribute): (() => void)
Type Parameters
- T
Parameters
- deviceId: string
- source: UniverseDataSource
- loader: ((data) => Promise<DataResult<T>>)
  - - (data): Promise<DataResult<T>>
    - Parameters
      data: IStreamData<keyof IStreamTypeMap>[]
      Returns Promise<DataResult<T>>
- distribute: ((data) => void)
  - - (data): void
    - Parameters
      data: T
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Inherited from BasicUniverseDataConnector.addRemovableTelemetrySubscription
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:271

clearWorkerPool

clearWorkerPool(): void
Returns void
Implementation of IUniverseData.clearWorkerPool
Inherited from BasicUniverseDataConnector.clearWorkerPool
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:191

`Protected` createH264Drawer

createH264Drawer(): H264BytestreamCanvasDrawer
Returns H264BytestreamCanvasDrawer
Inherited from BasicUniverseDataConnector.createH264Drawer
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:328

`Protected` createRealtimeConnection

createRealtimeConnection(deviceId, sessionType?): Promise<void>
Parameters
- deviceId: string
- sessionType: number = SessionType.TELEOP
Returns Promise<void>
Inherited from BasicUniverseDataConnector.createRealtimeConnection
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:232

fetchImage

fetchImage(url): Promise<HTMLImageElement>
Parameters
- url: string
Returns Promise<HTMLImageElement>
Inherited from BasicUniverseDataConnector.fetchImage
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:515

`Protected` getAvailableDataFetchWorker

getAvailableDataFetchWorker(): undefined | Worker
Returns undefined | Worker
Inherited from BasicUniverseDataConnector.getAvailableDataFetchWorker
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:171

`Protected` getAvailablePCDWorker

getAvailablePCDWorker(): undefined | Worker
Returns undefined | Worker
Inherited from BasicUniverseDataConnector.getAvailablePCDWorker
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:161

getDeviceContextName

getDeviceContextName(_deviceId): Promise<undefined | string>
Parameters
- _deviceId: string
Returns Promise<undefined | string>
Implementation of IUniverseData.getDeviceContextName
Inherited from BasicUniverseDataConnector.getDeviceContextName
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:490

getDeviceContexts

getDeviceContexts(): Promise<{
deviceId: string;
deviceName: string;
}[]>
Returns Promise<{
deviceId: string;
deviceName: string;
}[]>
Implementation of IUniverseData.getDeviceContexts
Inherited from BasicUniverseDataConnector.getDeviceContexts
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:484

getHardwareStreams

getHardwareStreams(_deviceId): Promise<IRealtimeStream[]>
Parameters
- _deviceId: string
Returns Promise<IRealtimeStream[]>
Implementation of IUniverseData.getHardwareStreams
Inherited from BasicUniverseDataConnector.getHardwareStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:427

getInteractions

getInteractions(): Interaction[]
Returns Interaction[]
Implementation of IUniverseData.getInteractions
Inherited from BasicUniverseDataConnector.getInteractions
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:439

getLatestLocations

getLatestLocations(): Promise<{
location: ILocation;
streamName: string;
}[]>
Returns Promise<{
location: ILocation;
streamName: string;
}[]>
Implementation of IUniverseData.getLatestLocations
Inherited from BasicUniverseDataConnector.getLatestLocations
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:467

getLatestTransformTrees

getLatestTransformTrees(_deviceId): Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>
Parameters
- _deviceId: string
Returns Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>
Implementation of IUniverseData.getLatestTransformTrees
Inherited from BasicUniverseDataConnector.getLatestTransformTrees
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:461

getRealtimeButtons

getRealtimeButtons(_deviceId): Promise<RealtimeButtonConfiguration[]>
Parameters
- _deviceId: string
Returns Promise<RealtimeButtonConfiguration[]>
Inherited from BasicUniverseDataConnector.getRealtimeButtons
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:455

getStatistics

getStatistics(): Promise<IUniverseStatistics>
Returns Promise<IUniverseStatistics>
Implementation of IUniverseData.getStatistics
Inherited from BasicUniverseDataConnector.getStatistics
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:501

getTelemetryStreamType

getTelemetryStreamType(_deviceId, _streamName): Promise<undefined | string>
Parameters
- _deviceId: string
- _streamName: string
Returns Promise<undefined | string>
Implementation of IUniverseData.getTelemetryStreamType
Inherited from BasicUniverseDataConnector.getTelemetryStreamType
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:494

getTelemetryStreams

getTelemetryStreams(_deviceId): Promise<ITelemetryStream[]>
Parameters
- _deviceId: string
Returns Promise<ITelemetryStream[]>
Implementation of IUniverseData.getTelemetryStreams
Inherited from BasicUniverseDataConnector.getTelemetryStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:419

getTeleopRosStreams

getTeleopRosStreams(_deviceId): Promise<ITelemetryRosStream[]>
Parameters
- _deviceId: string
Returns Promise<ITelemetryRosStream[]>
Implementation of IUniverseData.getTeleopRosStreams
Inherited from BasicUniverseDataConnector.getTeleopRosStreams
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:423

getUrdfs

getUrdfs(deviceId): Promise<string[]>
Parameters
- deviceId: string
Returns Promise<string[]>
Implementation of IUniverseData.getUrdfs
Inherited from BasicUniverseDataConnector.getUrdfs
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:409

`Protected` releaseDataFetchWorker

releaseDataFetchWorker(worker): void
Parameters
- worker: Worker
Returns void
Inherited from BasicUniverseDataConnector.releaseDataFetchWorker
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:186

`Protected` releasePCDWorker

releasePCDWorker(worker): void
Parameters
- worker: Worker
Returns void
Inherited from BasicUniverseDataConnector.releasePCDWorker
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:181

removeInteraction

removeInteraction(_id): void
Parameters
- _id: string
Returns void
Implementation of IUniverseData.removeInteraction
Inherited from BasicUniverseDataConnector.removeInteraction
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:435

sendCommand

sendCommand(deviceId, name, data?): Promise<void>
Parameters
- deviceId: string
- name: string
- Optional data: string
Returns Promise<void>
Implementation of IUniverseData.sendCommand
Inherited from BasicUniverseDataConnector.sendCommand
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:337

sendRealtimeBitset

sendRealtimeBitset(deviceId, streamName, bitset): Promise<void>
Parameters
- deviceId: string
- streamName: string
- bitset: IBitset
Returns Promise<void>
Implementation of IUniverseData.sendRealtimeBitset
Inherited from BasicUniverseDataConnector.sendRealtimeBitset
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:386

sendRealtimeBoolean

sendRealtimeBoolean(deviceId, streamName, value): Promise<void>
Parameters
- deviceId: string
- streamName: string
- value: boolean
Returns Promise<void>
Implementation of IUniverseData.sendRealtimeBoolean
Inherited from BasicUniverseDataConnector.sendRealtimeBoolean
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:368

sendRealtimePose

sendRealtimePose(deviceId, streamName, pose): Promise<void>
Parameters
- deviceId: string
- streamName: string
- pose: ITransform
Returns Promise<void>
Implementation of IUniverseData.sendRealtimePose
Inherited from BasicUniverseDataConnector.sendRealtimePose
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:349

`Protected` sendRtcMessage

sendRtcMessage(deviceId, msg): Promise<void>
Parameters
- deviceId: string
- msg: IRtcStreamMessage
Returns Promise<void>
Inherited from BasicUniverseDataConnector.sendRtcMessage
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:222

setTime

setTime(time): void
Parameters
- time: Date | "live"
Returns void
Implementation of IUniverseData.setTime
Inherited from BasicUniverseDataConnector.setTime
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:95

subcribeToVideo

subcribeToVideo(_deviceId, _source, _callback): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((frame) => void)
  - - (frame): void
    - Parameters
      frame: HTMLVideoElement
      Returns void
Returns CloseSubscription
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:57

subscribeDataSourceStateChange

subscribeDataSourceStateChange(_deviceId, _source, _onDataSourceStateChange?): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- Optional _onDataSourceStateChange: ((state) => void)
  - - (state): void
    - Parameters
      state: DataSourceState
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeDataSourceStateChange
Inherited from BasicUniverseDataConnector.subscribeDataSourceStateChange
- Defined in data-sdk/src/connector/data/BaseUniverseDataConnector.ts:507

subscribeToBitset

subscribeToBitset(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IBitset
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToBitset
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:65

subscribeToGeometry

subscribeToGeometry(_deviceId, _source, _callback): (() => void)
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IMarker3DArray
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToGeometry
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:536

subscribeToGridMap

subscribeToGridMap(deviceId, source, callback): (() => void)
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IUniverseGridMap
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToGridMap
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:583

subscribeToImage

subscribeToImage(_deviceId, _source, _callback): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((image) => void)
  - - (image): void
    - Parameters
      image: HTMLCanvasElement
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToImage
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:49

subscribeToJointState

subscribeToJointState(deviceId, source, callback): (() => void)
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IJointState
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToJointState
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:560

subscribeToJson

subscribeToJson<T>(deviceId, source, callback): CloseSubscription
Type Parameters
- T
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: T
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToJson
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:293

subscribeToLocation

subscribeToLocation(_deviceId, _source, _callback): (() => void)
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((data) => void)
  - - (data): void
    - Parameters
      data: ILocation
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToLocation
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:812

subscribeToNumeric

subscribeToNumeric(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((num) => void)
  - - (num): void
    - Parameters
      num: [number, number][]
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToNumeric
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:207

subscribeToNumericSet

subscribeToNumericSet(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((entry) => void)
  - - (entry): void
    - Parameters
      entry: [number, INumericSetEntry[]][]
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToNumericSet
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:230

subscribeToOdometry

subscribeToOdometry(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IUniverseOdometry
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToOdometry
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:98

subscribeToPath

subscribeToPath(_deviceId, _source, _callback): CloseSubscription
Parameters
- _deviceId: string
- _source: UniverseDataSource
- _callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Symbol | IUniversePath
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToPath
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:41

subscribeToPointCloud

subscribeToPointCloud(deviceId, source, callback): (() => void)
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IUniversePointCloud
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToPointCloud
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:385

subscribeToPose

subscribeToPose(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: IPose
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToPose
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:184

subscribeToRealtimeMessages

subscribeToRealtimeMessages(deviceId, streamName, callback): Promise<void>
Parameters
- deviceId: string
- streamName: string
- callback: RealtimeListener
Returns Promise<void>
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:260

subscribeToText

subscribeToText(deviceId, source, callback): CloseSubscription
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: string
      Returns void
Returns CloseSubscription
Implementation of IUniverseData.subscribeToText
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:347

subscribeToTransformTree

subscribeToTransformTree(deviceId, source, callback): (() => void)
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: ITransformNode
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToTransformTree
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:776

subscribeToVideo

subscribeToVideo(deviceId, source, callback): (() => void)
Parameters
- deviceId: string
- source: UniverseDataSource
- callback: ((frame) => void)
  - - (frame): void
    - Parameters
      frame: HTMLCanvasElement
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Implementation of IUniverseData.subscribeToVideo
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:682

unsubscribeToRealtimeMessages

unsubscribeToRealtimeMessages(deviceId, streamName, callback): Promise<void>
Parameters
- deviceId: string
- streamName: string
- callback: RealtimeListener
Returns Promise<void>
- Defined in data-sdk/src/connector/data/LiveUniverseData.ts:279

Class LiveUniverseData

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LiveUniverseData

Properties

dataFetchWorkerPool

dataFetchWorkerPoolOccupancy

lastQueriedHistoricTime

mapRealtimeConnections

pcdWorkerPool

pcdWorkerPoolOccupancy

queryStore

subscriberDistributorsLoaders

subscriberLoaders

subscriberSources

time

timeChangeListeners

Type declaration

Parameters

Returns void

Methods

addInteraction

Parameters

Returns void

addInteractionListener

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

addInteractionsChangedListener

Parameters

Parameters

Returns void

Returns (() => void)

Returns void

Protected addRemovableTelemetrySubscription

Type Parameters

Parameters

Parameters

Returns Promise<DataResult<T>>

Parameters

Returns void

Returns (() => void)

Returns void

clearWorkerPool

Returns void

Protected createH264Drawer

Returns H264BytestreamCanvasDrawer

Protected createRealtimeConnection

Parameters

Returns Promise<void>

fetchImage

Parameters

Returns Promise<HTMLImageElement>

Protected getAvailableDataFetchWorker

Returns undefined | Worker

Protected getAvailablePCDWorker

Returns undefined | Worker

getDeviceContextName

Parameters

Returns Promise<undefined | string>

getDeviceContexts

Returns Promise<{ deviceId: string; deviceName: string; }[]>

getHardwareStreams

Parameters

Returns Promise<IRealtimeStream[]>

getInteractions

Returns Interaction[]

getLatestLocations

Returns Promise<{ location: ILocation; streamName: string; }[]>

getLatestTransformTrees

Parameters

Returns Promise<{ streamName: string; transformTree: ITransformNode; }[]>

`Protected` addRemovableTelemetrySubscription

`Protected` createH264Drawer

`Protected` createRealtimeConnection

`Protected` getAvailableDataFetchWorker

`Protected` getAvailablePCDWorker

Returns Promise<{
deviceId: string;
deviceName: string;
}[]>

Returns Promise<{
location: ILocation;
streamName: string;
}[]>

Returns Promise<{
streamName: string;
transformTree: ITransformNode;
}[]>

`Protected` releaseDataFetchWorker

`Protected` releasePCDWorker

`Protected` sendRtcMessage