Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Device

Implements

Index

Constructors

  • new Device(id: string, name: string, organizationId: string): Device

Properties

id: string
name: string
realtimeListeners: RealtimeListener[] = []
remoteDevicePeerId: undefined | string
rtcClient: undefined | RtcClient

Methods

  • changeStreamAudioType(streamName: string, newFormat: "wav" | "opus"): Promise<void>
  • Parameters

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

    Returns Promise<void>

  • createCustomDataChannel(channelName: string, rtcConfig?: RTCDataChannelInit): Promise<DataChannel>
  • disableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>
  • enableRealtimeTelemetryPriorityIngestion(streamName: string): Promise<void>
  • getAvailableCommands(): Promise<Command[]>
  • getFileUrl(fileId: string): Promise<string[]>
  • getLatestTelemetry(): Promise<any>
  • getRealtimePing(): undefined | number
  • getRealtimeStatus(): "connected" | "connecting" | "disconnected"
  • getRemotePeer(): Promise<IRtcPeer>
  • getTelemetry(streamNameOrStreamNames: string | string[], start: Date, end: Date, tags?: {}): Promise<TelemetryResult[]>
  • handleMessage(peerId: string, message: any): void
  • isInRealtimeSession(): Promise<boolean>
  • sendCommand(name: string, data?: string, time?: Date, metadata?: {}): Promise<void>
  • Parameters

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

      Returns Promise<void>

    • startRealtimeConnection(config?: IRtcConnectConfiguration): Promise<void>
    • stopRealtimeConnection(): Promise<void>

    Generated using TypeDoc