Teleport

These pages document Teleport: the Spatial Internet Protocol, its reference implementation, tools and SDK’s. The documentation is given in the likely order that most users will approach Teleport: firstly, an introduction to the ideas and concepts behind the system. Secondly, a guide to the default Teleport Client client app. Thirdly, the official specification of the Teleport Protocol. Finally, the documentation of the Reference Implementation , which can be used to build Teleport clients or servers, including guides on using the Unity SDK, Unreal Engine SDK, or NodeJS SDK for setting up a virtual reality server.

Contents

• 1. Introduction
  • 1.1. Concepts
  • 1.2. Comparison to the World Wide Web
• 2. The Teleport Protocol
  • 2.1. Conventions
    • 2.1.1. Endianness, alignment and packing
    • 2.1.2. Identifiers
    • 2.1.3. Coordinate systems and units
    • 2.1.4. Time bases
    • 2.1.5. Versioning
  • 2.2. Connection State Machine
    • 2.2.1. Phases
    • 2.2.2. Reconnection
    • 2.2.3. Connection state enumeration
    • 2.2.4. Timeouts
  • 2.3. Signaling
    • 2.3.1. Connection
    • 2.3.2. Signal types
    • 2.3.3. After connection
  • 2.4. Data Service
    • 2.4.1. Initialization
    • 2.4.2. Command packets (server-to-client)
    • 2.4.3. Message packets (client-to-server)
    • 2.4.4. Setup Command
    • 2.4.5. Handshake
    • 2.4.6. Update
  • 2.5. Data Transfer
    • 2.5.1. Reliability requirements
    • 2.5.2. WebRTC transport (default)
    • 2.5.3. Legacy transport: SRT + EFP
  • 2.6. HTTP Service
    • 2.6.1. Endpoint
    • 2.6.2. URL format
    • 2.6.3. Client behaviour
    • 2.6.4. Lifecycle
    • 2.6.5. Sequence
    • 2.6.6. Operational notes for implementers
  • 2.7. Video
    • 2.7.1. Video Texture Layout
    • 2.7.2. Video Frame Structure
    • 2.7.3. Recovering from Corruption
    • 2.7.4. Minimizing Latency
    • 2.7.5. Processing of video Frame on the Client
  • 2.8. Video Metadata
    • 2.8.1. Structure of Metadata
    • 2.8.2. Sending Metadata to the Client
    • 2.8.3. Processing Metadata on the Client
  • 2.9. Geometry Payload
    • 2.9.1. Channel framing
    • 2.9.2. Payload types
    • 2.9.3. Node payload
    • 2.9.4. Mesh payload
    • 2.9.5. Material payload
    • 2.9.6. MaterialInstance payload
    • 2.9.7. Texture payload
    • 2.9.8. Animation payload
    • 2.9.9. Skeleton payload
    • 2.9.10. FontAtlas payload
    • 2.9.11. TextCanvas payload
    • 2.9.12. TexturePointer payload
    • 2.9.13. MeshPointer payload
    • 2.9.14. MaterialPointer payload
    • 2.9.15. RemoveNodes payload
    • 2.9.16. Resource lifecycle
    • 2.9.17. Axis conversion
    • 2.9.18. Coding conventions
  • 2.10. Audio
    • 2.10.1. Codec and RTP parameters
    • 2.10.2. Topology
    • 2.10.3. AudioConfig (inside SetupCommand)
    • 2.10.4. Selection policy and caps
    • 2.10.5. AudioSourceMapping command
    • 2.10.6. AudioParticipantStateChange command
    • 2.10.7. Join and leave
    • 2.10.8. Example
    • 2.10.9. Lifecycle
  • 2.11. Input
    • 2.11.1. Negotiation: SetupInputsCommand
    • 2.11.2. InputType bitfield
    • 2.11.3. Reporting: InputStatesMessage
    • 2.11.4. Reporting: InputEventsMessage
    • 2.11.5. Pose stream
    • 2.11.6. Sequence
    • 2.11.7. Operational notes for implementers
• 3. Reference Implementation
  • 3.1. Teleport Unity SDK
    • 3.1.1. Getting Started
    • 3.1.2. Configuration
    • 3.1.3. Resource Management
    • 3.1.4. Usage
    • 3.1.5. Inputs
    • 3.1.6. Player Session Hierarchy
    • 3.1.7. SDK Reference
  • 3.2. Teleport Unreal SDK
    • 3.2.1. Getting Started
    • 3.2.2. Configuration
    • 3.2.3. Resource Management
    • 3.2.4. Usage
    • 3.2.5. Inputs
    • 3.2.6. Player Session Hierarchy
    • 3.2.7. SDK Reference
  • 3.3. Teleport NodeJS SDK
    • 3.3.1. Getting Started
  • 3.4. Server
    • 3.4.1. Introduction
    • 3.4.2. API
    • 3.4.3. Classes
    • 3.4.4. Networking
  • 3.5. The Teleport Client library
    • 3.5.1. Introduction
    • 3.5.2. Tab Context
    • 3.5.3. Session Client
    • 3.5.4. Classes
  • 3.6. LibAVStream
    • 3.6.1. Introduction
    • 3.6.2. Namespace
  • 3.7. LibAVStream Example
    • 3.7.1. Introduction
    • 3.7.2. Video Stream Example
  • 3.8. The Teleport Core library
    • 3.8.1. Introduction
    • 3.8.2. Commands
    • 3.8.3. Client Messages
    • 3.8.4. Animation
    • 3.8.5. Input and control
    • 3.8.6. Text and Fonts
  • 3.9. Client Render Library
    • 3.9.1. Classes
    • 3.9.2. Structs
  • 3.10. Video Decoding with Android NDK
    • 3.10.1. AMediaCodec Set Up
    • 3.10.2. Running the Decoder
  • 3.11. Video with Vulkan on Android
    • 3.11.1. Importing a Video Stream into Vulkan
    • 3.11.2. Vulkan Sampler YCbCr Conversion

Indices and tables

• Index

• Module Index

• Search Page