Class PeerDevice

Hierarchy

  • BaseDevice
    • PeerDevice

Constructors

constructor

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

Properties

Protected connectionMonitorInterval

connectionMonitorInterval: undefined | Timeout

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

addRealtimeListener

  • addRealtimeListener(listener): void

  • Parameters

    Returns void

Protected assertNotCancelled

  • assertNotCancelled(cancelled): void

  • Parameters

    • cancelled: boolean

    Returns void

changeStreamAudioType

  • changeStreamAudioType(streamName, newFormat): Promise<void>

  • Parameters

    • streamName: string
    • newFormat: "wav" | "opus"

    Returns Promise<void>

Private checkKeysAndThrow

  • checkKeysAndThrow(obj, keysToCheck): void

  • Parameters

    • obj: any
    • keysToCheck: string[]

    Returns void

createCustomBinaryRequestDataChannel

  • createCustomBinaryRequestDataChannel(channelName, timeout?): BinaryRequestDataChannel

  • Parameters

    • channelName: string
    • timeout: number = 3000

    Returns BinaryRequestDataChannel

createCustomDataChannel

  • createCustomDataChannel(channelName, rtcConfig?): Promise<DataChannel>

  • Parameters

    • channelName: string
    • Optional rtcConfig: RTCDataChannelInit

    Returns Promise<DataChannel>

createCustomRequestDataChannel

  • createCustomRequestDataChannel(channelName, timeout?): TextRequestDataChannel

  • Parameters

    • channelName: string
    • timeout: number = 3000

    Returns TextRequestDataChannel

disableRealtimeTelemetryPriorityIngestion

  • disableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>

  • Parameters

    • streamName: string

    Returns Promise<void>

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

enableRealtimeTelemetryPriorityIngestion

  • enableRealtimeTelemetryPriorityIngestion(streamName): Promise<void>

  • Parameters

    • streamName: string

    Returns Promise<void>

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

getCommandMetadata

  • getCommandMetadata(): Promise<{
        commands: any[];
    }>

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

getConfiguration

getDeviceId

  • getDeviceId(): Promise<string>

  • Returns Promise<string>

getLatestTelemetry

Private getPointPayload

  • getPointPayload(type, datapoint): any

  • Parameters

    • type: string
    • datapoint: any

    Returns any

getRealtimeAudioStreams

  • getRealtimeAudioStreams(): Promise<RealtimeAudioStream[]>

  • Returns Promise<RealtimeAudioStream[]>

getRealtimeManipulators

  • getRealtimeManipulators(): Promise<Manipulator[]>

  • Returns Promise<Manipulator[]>

getRealtimePing

  • getRealtimePing(): undefined | number

  • Returns undefined | number

getRealtimePingInfo

  • getRealtimePingInfo(): undefined | IPingInfo

  • Returns undefined | IPingInfo

getRealtimeStatus

  • getRealtimeStatus(): "connecting" | "disconnected" | "connected"

  • Returns "connecting" | "disconnected" | "connected"

getRealtimeVideoStreams

  • getRealtimeVideoStreams(): Promise<RealtimeVideoStream[]>

  • Returns Promise<RealtimeVideoStream[]>

getRemotePeer

  • getRemotePeer(): Promise<IRtcPeer>

  • Returns Promise<IRtcPeer>

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[]>

    getViews

    • getViews(): Promise<IView[]>

    • Returns Promise<IView[]>

    Protected handleMessage

    • handleMessage(peerId, message): void

    • Parameters

      • peerId: string
      • message: any

      Returns void

    Private handleXHRError

    • handleXHRError(reason): void

    • Parameters

      • reason: string

      Returns void

    Private initConnectionMonitoring

    • initConnectionMonitoring(): void

    • Returns void

    listenerCount

    • listenerCount(event): number

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

      Returns number

    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)[]

    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

    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

    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

    queryEvents

    • queryEvents(query): Promise<IEvent[]>

    • Parameters

      Returns Promise<IEvent[]>

    removeAllListeners

    • removeAllListeners(event?): this

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optional event: string | symbol

      Returns this

    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

    removeRealtimeListener

    • removeRealtimeListener(listener): void

    • Parameters

      Returns void

    sendCommand

    • sendCommand(name, data?, time?, metadata?): Promise<Response>

    • Parameters

      • name: string
      • Optional data: string
      • Optional time: Date
      • Optional metadata: {}

        Returns Promise<Response>

      sendRealtimeMessage

      • sendRealtimeMessage(message, config?): Promise<void>

      • Parameters

        Returns Promise<void>

      startListeningToRealtimeDataStream

      • startListeningToRealtimeDataStream(stream): Promise<void>

      • Parameters

        Returns Promise<void>

      startListeningToRealtimeVideo

      • startListeningToRealtimeVideo(stream): Promise<void>

      • Parameters

        Returns Promise<void>

      startRealtimeConnection

      • startRealtimeConnection(sessionType?): Promise<void>

      • Parameters

        • Optional sessionType: number

        Returns Promise<void>

      Protected stopConnectionMonitoring

      • stopConnectionMonitoring(): void

      • Returns void

      stopListeningToRealtimeDataStream

      • stopListeningToRealtimeDataStream(stream): Promise<void>

      • Parameters

        Returns Promise<void>

      stopListeningToRealtimeVideo

      • stopListeningToRealtimeVideo(stream): Promise<void>

      • Parameters

        Returns Promise<void>

      stopRealtimeConnection

      • stopRealtimeConnection(): Promise<void>

      • Returns Promise<void>

      Private subscribeToTelemetry

      • subscribeToTelemetry(): void

      • Returns void

      Settings

      Member Visibility

      Theme

      On This Page

      constructorconnectionMonitorIntervalidpeerUrlrealtimeListenersremoteDevicePeerIdrtcClientstreamTelemetrytelemetryStreamActiveprefixedaddListeneraddRealtimeListenerassertNotCancelledchangeStreamAudioTypecheckKeysAndThrowcreateCustomBinaryRequestDataChannelcreateCustomDataChannelcreateCustomRequestDataChanneldisableRealtimeTelemetryPriorityIngestionemitenableRealtimeTelemetryPriorityIngestioneventNamesgetCommandMetadatagetConfigurationgetDeviceIdgetLatestTelemetrygetPointPayloadgetRealtimeAudioStreamsgetRealtimeManipulatorsgetRealtimePinggetRealtimePingInfogetRealtimeStatusgetRealtimeVideoStreamsgetRemotePeergetTelemetrygetViewshandleMessagehandleXHRErrorinitConnectionMonitoringlistenerCountlistenersoffononcequeryEventsremoveAllListenersremoveListenerremoveRealtimeListenersendCommandsendRealtimeMessagestartListeningToRealtimeDataStreamstartListeningToRealtimeVideostartRealtimeConnectionstopConnectionMonitoringstopListeningToRealtimeDataStreamstopListeningToRealtimeVideostopRealtimeConnectionsubscribeToTelemetry