Class PeerDevice

Hierarchy

BaseDevice
- PeerDevice

Index

Constructors

Properties

connectionMonitorInterval id peerUrl realtimeListeners remoteDevicePeerId rtcClient streamTelemetry telemetryStreamActive prefixed

Methods

addListener addRealtimeListener assertNotCancelled changeStreamAudioType checkKeysAndThrow createCustomBinaryRequestDataChannel createCustomDataChannel createCustomRequestDataChannel disableRealtimeTelemetryPriorityIngestion emit enableRealtimeTelemetryPriorityIngestion eventNames getCommandMetadata getConfiguration getDeviceId getLatestTelemetry getPointPayload getRealtimeAudioStreams getRealtimeManipulators getRealtimePing getRealtimePingInfo getRealtimeStatus getRealtimeVideoStreams getRemotePeer getTelemetry getViews handleMessage handleXHRError initConnectionMonitoring listenerCount listeners off on once queryEvents removeAllListeners removeListener removeRealtimeListener sendCommand sendRealtimeMessage startListeningToRealtimeDataStream startListeningToRealtimeVideo startRealtimeConnection stopConnectionMonitoring stopListeningToRealtimeDataStream stopListeningToRealtimeVideo stopRealtimeConnection subscribeToTelemetry

Constructors

constructor

new PeerDevice(peerUrl): PeerDevice
Parameters
- peerUrl: string
Returns PeerDevice
Overrides BaseDevice.constructor
- Defined in data-sdk/src/devices/PeerDevice.ts:17

Properties

`Protected` connectionMonitorInterval

connectionMonitorInterval: undefined | Timer

id

id: string

peerUrl

peerUrl: string

`Protected` realtimeListeners

realtimeListeners: RealtimeListener[] = []

remoteDevicePeerId

remoteDevicePeerId: null | string = null

rtcClient

rtcClient: undefined | RtcClient

`Private` streamTelemetry

streamTelemetry: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

`Private` telemetryStreamActive

telemetryStreamActive: boolean = false

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.addListener
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:45

addRealtimeListener

addRealtimeListener(listener): void
Parameters
- listener: RealtimeListener
Returns void
Inherited from BaseDevice.addRealtimeListener
- Defined in data-sdk/src/devices/BaseDevice.ts:93

`Protected` assertNotCancelled

assertNotCancelled(cancelled): void
Parameters
- cancelled: boolean
Returns void
Inherited from BaseDevice.assertNotCancelled
- Defined in data-sdk/src/devices/BaseDevice.ts:65

changeStreamAudioType

changeStreamAudioType(streamName, newFormat): Promise<void>
Parameters
- streamName: string
- newFormat: "wav" | "opus"
Returns Promise<void>
Inherited from BaseDevice.changeStreamAudioType
- Defined in data-sdk/src/devices/BaseDevice.ts:266

`Private` checkKeysAndThrow

checkKeysAndThrow(obj, keysToCheck): void
Parameters
- obj: any
- keysToCheck: string[]
Returns void
- Defined in data-sdk/src/devices/PeerDevice.ts:177

createCustomBinaryRequestDataChannel

createCustomBinaryRequestDataChannel(channelName, timeout?): BinaryRequestDataChannel
Parameters
- channelName: string
- timeout: number = 3000
Returns BinaryRequestDataChannel
Inherited from BaseDevice.createCustomBinaryRequestDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:177

createCustomDataChannel

createCustomDataChannel(channelName, rtcConfig?): Promise<DataChannel>
Parameters
- channelName: string
- Optional rtcConfig: RTCDataChannelInit
Returns Promise<DataChannel>
Inherited from BaseDevice.createCustomDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:279

createCustomRequestDataChannel

createCustomRequestDataChannel(channelName, timeout?): TextRequestDataChannel
Parameters
- channelName: string
- timeout: number = 3000
Returns TextRequestDataChannel
Inherited from BaseDevice.createCustomRequestDataChannel
- Defined in data-sdk/src/devices/BaseDevice.ts:170

disableRealtimeTelemetryPriorityIngestion

disableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>
Parameters
- streamName: string
Returns Promise<void>
Inherited from BaseDevice.disableRealtimeTelemetryPriorityIngestion
- Defined in data-sdk/src/devices/BaseDevice.ts:252

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Rest ...args: any[]
Returns boolean
Inherited from BaseDevice.emit
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:32

enableRealtimeTelemetryPriorityIngestion

enableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>
Parameters
- streamName: string
Returns Promise<void>
Inherited from BaseDevice.enableRealtimeTelemetryPriorityIngestion
- Defined in data-sdk/src/devices/BaseDevice.ts:238

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from BaseDevice.eventNames
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:15

getCommandMetadata

getCommandMetadata(): Promise<{
commands: any[];
}>
Returns Promise<{
commands: any[];
}>
- Defined in data-sdk/src/devices/PeerDevice.ts:381

getConfiguration

getConfiguration(): Promise<ConfigurationDocument>
Returns Promise<ConfigurationDocument>
Overrides BaseDevice.getConfiguration
- Defined in data-sdk/src/devices/PeerDevice.ts:282

getDeviceId

getDeviceId(): Promise<string>
Returns Promise<string>
- Defined in data-sdk/src/devices/PeerDevice.ts:276

getLatestTelemetry

getLatestTelemetry(): Promise<IStreamCurrentValue<any>[]>
Returns Promise<IStreamCurrentValue<any>[]>
- Defined in data-sdk/src/devices/PeerDevice.ts:21

`Private` getPointPayload

getPointPayload(type, datapoint): any
Parameters
- type: string
- datapoint: any
Returns any
- Defined in data-sdk/src/devices/PeerDevice.ts:187

getRealtimeAudioStreams

getRealtimeAudioStreams(): Promise<RealtimeAudioStream[]>
Returns Promise<RealtimeAudioStream[]>
Inherited from BaseDevice.getRealtimeAudioStreams
- Defined in data-sdk/src/devices/BaseDevice.ts:323

getRealtimeManipulators

getRealtimeManipulators(): Promise<Manipulator[]>
Returns Promise<Manipulator[]>
Inherited from BaseDevice.getRealtimeManipulators
- Defined in data-sdk/src/devices/BaseDevice.ts:105

getRealtimePing

getRealtimePing(): undefined | number
Returns undefined | number
Inherited from BaseDevice.getRealtimePing
- Defined in data-sdk/src/devices/BaseDevice.ts:85

getRealtimePingInfo

getRealtimePingInfo(): undefined | IPingInfo
Returns undefined | IPingInfo
Inherited from BaseDevice.getRealtimePingInfo
- Defined in data-sdk/src/devices/BaseDevice.ts:77

getRealtimeStatus

getRealtimeStatus(): "connected" | "connecting" | "disconnected"
Returns "connected" | "connecting" | "disconnected"
Inherited from BaseDevice.getRealtimeStatus
- Defined in data-sdk/src/devices/BaseDevice.ts:69

getRealtimeVideoStreams

getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>
Returns Promise<RealtimeVideoStream[]>
Inherited from BaseDevice.getRealtimeVideoStreams
- Defined in data-sdk/src/devices/BaseDevice.ts:133

getRemotePeer

getRemotePeer(): Promise<IRtcPeer>
Returns Promise<IRtcPeer>
Overrides BaseDevice.getRemotePeer
- Defined in data-sdk/src/devices/PeerDevice.ts:346

getTelemetry

getTelemetry(streamNameOrStreamNames, start, end, tags?, limit?, offset?, latestOnly?): Promise<TelemetryResult[]>
Parameters
- streamNameOrStreamNames: string | string[]
- start: Date
- end: Date
- Optional tags: {}
- Optional limit: number
- Optional offset: number
- Optional latestOnly: boolean
Returns Promise<TelemetryResult[]>
Overrides BaseDevice.getTelemetry
- Defined in data-sdk/src/devices/PeerDevice.ts:43

getViews

getViews(): Promise<IView[]>
Returns Promise<IView[]>
- Defined in data-sdk/src/devices/PeerDevice.ts:288

`Protected` handleMessage

handleMessage(peerId, message): void
Parameters
- peerId: string
- message: any
Returns void
Inherited from BaseDevice.handleMessage
- Defined in data-sdk/src/devices/BaseDevice.ts:56

`Private` handleXHRError

handleXHRError(reason): void
Parameters
- reason: string
Returns void
- Defined in data-sdk/src/devices/PeerDevice.ts:271

`Private` initConnectionMonitoring

initConnectionMonitoring(): void
Returns void
- Defined in data-sdk/src/devices/PeerDevice.ts:326

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from BaseDevice.listenerCount
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from BaseDevice.listeners
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from BaseDevice.off
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.on
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from BaseDevice.once
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:54

queryEvents

queryEvents(query): Promise<IEvent[]>
Parameters
- query: IEventQuery
Returns Promise<IEvent[]>
Overrides BaseDevice.queryEvents
- Defined in data-sdk/src/devices/PeerDevice.ts:97

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns this
Inherited from BaseDevice.removeAllListeners
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from BaseDevice.removeListener
- Defined in data-sdk/node_modules/eventemitter3/index.d.ts:63

removeRealtimeListener

removeRealtimeListener(listener): void
Parameters
- listener: RealtimeListener
Returns void
Inherited from BaseDevice.removeRealtimeListener
- Defined in data-sdk/src/devices/BaseDevice.ts:97

sendCommand

sendCommand(name, data?, time?, metadata?): Promise<Response>
Parameters
- name: string
- Optional data: string
- Optional time: Date
- Optional metadata: {}
Returns Promise<Response>
- Defined in data-sdk/src/devices/PeerDevice.ts:385

sendRealtimeMessage

sendRealtimeMessage(message, config?): Promise<void>
Parameters
- message: IRtcStreamMessage
- config: IRtcSendConfiguration = ...
Returns Promise<void>
Inherited from BaseDevice.sendRealtimeMessage
- Defined in data-sdk/src/devices/BaseDevice.ts:308

startListeningToRealtimeDataStream

startListeningToRealtimeDataStream(stream): Promise<void>
Parameters
- stream: RealtimeDataStream
Returns Promise<void>
Inherited from BaseDevice.startListeningToRealtimeDataStream
- Defined in data-sdk/src/devices/BaseDevice.ts:211

startListeningToRealtimeVideo

startListeningToRealtimeVideo(stream): Promise<void>
Parameters
- stream: RealtimeVideoStream
Returns Promise<void>
Inherited from BaseDevice.startListeningToRealtimeVideo
- Defined in data-sdk/src/devices/BaseDevice.ts:184

startRealtimeConnection

startRealtimeConnection(sessionType?): Promise<void>
Parameters
- Optional sessionType: number
Returns Promise<void>
Overrides BaseDevice.startRealtimeConnection
- Defined in data-sdk/src/devices/PeerDevice.ts:294

`Protected` stopConnectionMonitoring

stopConnectionMonitoring(): void
Returns void
Inherited from BaseDevice.stopConnectionMonitoring
- Defined in data-sdk/src/devices/BaseDevice.ts:60

stopListeningToRealtimeDataStream

stopListeningToRealtimeDataStream(stream): Promise<void>
Parameters
- stream: RealtimeDataStream
Returns Promise<void>
Inherited from BaseDevice.stopListeningToRealtimeDataStream
- Defined in data-sdk/src/devices/BaseDevice.ts:225

stopListeningToRealtimeVideo

stopListeningToRealtimeVideo(stream): Promise<void>
Parameters
- stream: RealtimeVideoStream
Returns Promise<void>
Inherited from BaseDevice.stopListeningToRealtimeVideo
- Defined in data-sdk/src/devices/BaseDevice.ts:198

stopRealtimeConnection

stopRealtimeConnection(): Promise<void>
Returns Promise<void>
- Defined in data-sdk/src/devices/PeerDevice.ts:356

`Private` subscribeToTelemetry

subscribeToTelemetry(): void
Returns void
- Defined in data-sdk/src/devices/PeerDevice.ts:219

Class PeerDevice

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PeerDevice

Properties

Protected connectionMonitorInterval

id

peerUrl

Protected realtimeListeners

remoteDevicePeerId

rtcClient

Private streamTelemetry

Type declaration

[key: string]: any

Private telemetryStreamActive

Static prefixed

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

addRealtimeListener

Parameters

Returns void

Protected assertNotCancelled

Parameters

Returns void

changeStreamAudioType

Parameters

Returns Promise<void>

Private checkKeysAndThrow

Parameters

Returns void

createCustomBinaryRequestDataChannel

Parameters

Returns BinaryRequestDataChannel

createCustomDataChannel

Parameters

Returns Promise<DataChannel>

createCustomRequestDataChannel

Parameters

Returns TextRequestDataChannel

disableRealtimeTelemetryPriorityIngestion

Parameters

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

enableRealtimeTelemetryPriorityIngestion

Parameters

Returns Promise<void>

eventNames

Returns (string | symbol)[]

getCommandMetadata

Returns Promise<{ commands: any[]; }>

getConfiguration

Returns Promise<ConfigurationDocument>

getDeviceId

Returns Promise<string>

getLatestTelemetry

Returns Promise<IStreamCurrentValue<any>[]>

Private getPointPayload

Parameters

Returns any

getRealtimeAudioStreams

Returns Promise<RealtimeAudioStream[]>

getRealtimeManipulators

Returns Promise<Manipulator[]>

getRealtimePing

Returns undefined | number

getRealtimePingInfo

`Protected` connectionMonitorInterval

`Protected` realtimeListeners

`Private` streamTelemetry

`Private` telemetryStreamActive

`Static` prefixed

`Protected` assertNotCancelled

`Private` checkKeysAndThrow

Returns Promise<{
commands: any[];
}>

`Private` getPointPayload

`Protected` handleMessage

`Private` handleXHRError

`Private` initConnectionMonitoring