WebSocketAdapter | Mixed Reality Extension SDK

The WebSocketAdapter is appropriate to use when the host environment has an authoritative simluation, and that authoritative simulation is the only connection made to the Mixed Reality Extension (MRE) app.

Example hosts:

Single player environments
Server-based multiuser topologies

Hierarchy

Adapter
- WebSocketAdapter

Index

Constructors

constructor

new WebSocketAdapter(options?: WebSocketAdapterOptions): WebSocketAdapter

Overrides Adapter.constructor
- Defined in src/core/websocketAdapter.ts:31
Creates a new instance of the WebSocket Adapter.

Parameters
- Optional options: WebSocketAdapterOptions
Returns WebSocketAdapter

Events

onConnection

onConnection(handler: (context: Context, params: ParameterSet) => void): this

Inherited from Adapter.onConnection
- Defined in src/internal/adapters/adapter.ts:57
The onConnection event is raised when a new Context is created for an application session. This happens when the first client connects to your application.

Parameters
- handler: (context: Context, params: ParameterSet) => void
  - - (context: Context, params: ParameterSet): void
    - Parameters
      - context: Context
      - params: ParameterSet
      Returns void
Returns this

Accessors

port

get port(): string | number

Inherited from Adapter.port
- Defined in src/internal/adapters/adapter.ts:39
Returns string | number

server

get server(): Server
set server(value: Server): void

Inherited from Adapter.server
- Defined in src/internal/adapters/adapter.ts:37
Returns Server
Inherited from Adapter.server
- Defined in src/internal/adapters/adapter.ts:38
Parameters
- value: Server
Returns void

Methods

listen

listen(): Promise<Server>

Overrides Adapter.listen
- Defined in src/core/websocketAdapter.ts:43
Start the adapter listening for new connections.

Returns Promise<Server>

Hierarchy

Index

Constructors

Events

Accessors

Methods

Constructors

constructor

Parameters

Optional options: WebSocketAdapterOptions

Returns WebSocketAdapter

Events

onConnection

Parameters

handler: (context: Context, params: ParameterSet) => void

Parameters

context: Context

params: ParameterSet

Returns void

Returns this

Accessors

port

Returns string | number

server

Returns Server

Parameters

value: Server

Returns void

Methods

listen

Returns Promise<Server>