CloudXR.js API Reference

API reference documentation for the CloudXR.js SDK, automatically generated from TypeScript source.

For user guides, tutorials, and integration documentation, see the CloudXR SDK Documentation.

• CloudXR.js SDK v6.0.1-beta
  • Modules
• Module: CloudXR
  • Enumerations
  • Interfaces
  • Type Aliases
  • Functions

• Function: createSession()
  • Parameters
    • options
    • delegates?
  • Returns
  • Throws
  • Throws
  • Throws
  • Examples
• Interface: MessageChannel
  • Example
  • Extends
  • Properties
    • uuid
    • status
    • receivedMessageStream
  • Methods
    • sendServerMessage()
    • receiveMessage()
    • disconnect()
• Interface: Session
  • Example
  • Properties
    • state
    • availableMessageChannels
  • Methods
    • connect()
    • disconnect()
    • sendTrackingStateToServer()
    • render()
    • sendServerMessage()
• Interface: SessionDelegates
  • Example
  • Properties
    • onStreamStarted()?
    • onStreamStopped()?
    • onWebGLStateChangeBegin()?
    • onWebGLStateChangeEnd()?
    • onServerMessageReceived()?
    • onMetrics()?
• Interface: SessionOptions
  • Example
  • Properties
    • serverAddress
    • serverPort
    • useSecureConnection
    • gl
    • perEyeWidth
    • perEyeHeight
    • referenceSpace
    • glBinding?
    • codec?
    • deviceFrameRate?
    • maxStreamingBitrateKbps?
    • telemetry?
    • enablePoseSmoothing?
    • posePredictionFactor?
• Enumeration: MessageChannelStatus
  • Enumeration Members
    • NotInitialized
    • Ready
    • Closed
• Enumeration: MetricsCadence
  • Enumeration Members
    • PerFrame
    • PerRender
• Enumeration: MetricsName
  • Enumeration Members
    • RenderFramerate
    • PoseToRenderTime
    • StreamingFramerate
• Enumeration: SessionState
  • Example
  • Enumeration Members
    • Initialized
    • Connecting
    • Connected
    • Disconnecting
    • Disconnected
    • Error
• Type Alias: Metrics