Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @pureweb/platform-sdk

Index

References

Enumerations

Classes

Interfaces

Type aliases

Properties

Variables

Functions

References

AgentPlatformSDK

Renames and exports default

Type aliases

AccessToken

AccessToken: { access_token: string; expires_in: number; token_type: string }

Type declaration

  • access_token: string
  • expires_in: number
  • token_type: string

Context

Context: {}

Type declaration

  • [key: string]: any

Contribution

Contribution: { agentId?: string; data?: string; environmentId?: string; id?: string; type: string }

Type declaration

  • Optional agentId?: string
  • Optional data?: string
  • Optional environmentId?: string
  • Optional id?: string
  • type: string

ContributionEvent

ContributionEvent<T>: { contribution?: SupportedContribution<T>; id: string; type: ContributionTypes }

Type parameters

  • T: SupportedContributionsKey

Type declaration

  • Optional contribution?: SupportedContribution<T>
  • id: string
  • type: ContributionTypes

ContributionsEvent

ContributionsEvent: { agentId: string; contribution: CONTRIBUTION | WITHDRAWAL; data: string; environmentId: string; id: string; type: string }

Type declaration

  • agentId: string
  • contribution: CONTRIBUTION | WITHDRAWAL
  • data: string
  • environmentId: string
  • id: string
  • type: string

IRemoteAgent

IRemoteAgent: IAgent

LogLevel

LogLevel: "trace" | "debug" | "warn" | "info" | "error"

MessageEvent

MessageEvent: { messageId: string; payload: string; senderId: string; timestamp: string; type: string }

Type declaration

  • messageId: string
  • payload: string
  • senderId: string
  • timestamp: string
  • type: string

PresenceEvent

PresenceEvent: { agentId: string; environmentId: string; type: ARRIVAL | DEPARTURE }

Type declaration

StorageEvent

StorageEvent: { agentId: string; environmentId: string; key: string; type: WRITE | REMOVE; value: string }

Type declaration

  • agentId: string
  • environmentId: string
  • key: string
  • type: WRITE | REMOVE
  • value: string

StreamContributionElements

StreamContributionElements: { audioStream: MediaStream; inputEmitter: InputEmitter; messageReceiver: Subject<string>; peerConnection: RTCPeerConnection; videoStream: MediaStream }

Type declaration

  • audioStream: MediaStream
  • inputEmitter: InputEmitter
  • messageReceiver: Subject<string>
  • peerConnection: RTCPeerConnection
  • videoStream: MediaStream

Properties

default

default: AgentPlatformSDK

Variables

Const DefaultStreamerOptions

DefaultStreamerOptions: StreamerOptions = ...

Const LogLevelValue

LogLevelValue: Map<LogLevel, number> = ...

Functions

Const attachKeyInput

  • attachKeyInput(reservedKeys: string[], emitter: InputEmitter): void

  • Parameters

    Returns void

Const attachMouseInput

  • attachMouseInput(videoRef: HTMLVideoElement, emitter: InputEmitter, useNativeTouchEvents?: boolean, usePointerLock: boolean, pointerLockRelease: boolean): void

  • Parameters

    • videoRef: HTMLVideoElement
    • emitter: InputEmitter
    • useNativeTouchEvents: boolean = false
    • usePointerLock: boolean
    • pointerLockRelease: boolean

    Returns void

Generated using TypeDoc