Class PeerDevice

Hierarchy

  • BaseDevice
    • PeerDevice

Constructors

constructor

Properties

connectionMonitorInterval id peerUrl realtimeListeners remoteDevicePeerId rtcClient streamTelemetry telemetryStreamActive prefixed

Methods

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

Constructors

constructor

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

addRealtimeListener

Protected assertNotCancelled

changeStreamAudioType

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

  • Parameters

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

    Returns Promise<void>

createCustomBinaryRequestDataChannel

createCustomDataChannel

createCustomRequestDataChannel

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

getConfiguration

getDeviceId

getLatestTelemetry

getRealtimeAudioStreams

getRealtimeManipulators

getRealtimePing

getRealtimeStatus

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

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

getRealtimeVideoStreams

getRemotePeer

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

    Protected handleMessage

    Private handleXHRError

    Private initConnectionMonitoring

    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

    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

    sendCommand

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

    • Parameters

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

        Returns Promise<Response>

      sendRealtimeMessage

      startListeningToRealtimeDataStream

      startListeningToRealtimeVideo

      startRealtimeConnection

      • startRealtimeConnection(sessionType?): Promise<void>

      • Parameters

        • Optional sessionType: number

        Returns Promise<void>

      Protected stopConnectionMonitoring

      stopListeningToRealtimeDataStream

      stopListeningToRealtimeVideo

      stopRealtimeConnection

      Private subscribeToTelemetry

      Settings

      Member Visibility

      Theme

      On This Page

      constructorconnectionMonitorIntervalidpeerUrlrealtimeListenersremoteDevicePeerIdrtcClientstreamTelemetrytelemetryStreamActiveprefixedaddListeneraddRealtimeListenerassertNotCancelledchangeStreamAudioTypecreateCustomBinaryRequestDataChannelcreateCustomDataChannelcreateCustomRequestDataChanneldisableRealtimeTelemetryPriorityIngestionemitenableRealtimeTelemetryPriorityIngestioneventNamesgetCommandMetadatagetConfigurationgetDeviceIdgetLatestTelemetrygetRealtimeAudioStreamsgetRealtimeManipulatorsgetRealtimePinggetRealtimeStatusgetRealtimeVideoStreamsgetRemotePeergetTelemetryhandleMessagehandleXHRErrorinitConnectionMonitoringlistenerCountlistenersoffononceremoveAllListenersremoveListenerremoveRealtimeListenersendCommandsendRealtimeMessagestartListeningToRealtimeDataStreamstartListeningToRealtimeVideostartRealtimeConnectionstopConnectionMonitoringstopListeningToRealtimeDataStreamstopListeningToRealtimeVideostopRealtimeConnectionsubscribeToTelemetry

      Generated using TypeDoc