Documentation
  • Welcome to Odyssey
  • Upload a project
    • Getting Started
    • Set up your project
    • Package for Linux (it's easy)
    • Upload your project
    • Create and publish your space
  • Instant Multiplayer
    • Quickstart
    • Spatial voice & video
      • Add spatial comms to player
      • Huddle
      • Share your screen
    • Avatars
      • Using Avatars
      • Avatar Blueprints
  • Realtime Configurator
    • Quickstart
    • Sketchfab importer
    • Actor importer
    • Level & object configurator
      • Level configurator
      • Object configurator
      • Configurator blueprint API
    • Media importer
      • Vimeo & web panels
      • Dolby.io in-world streams
  • Embed in a website
    • Enable embedding
    • Pass messages to and from Unreal
      • Sending messages to Unreal
      • Receiving messages from Unreal
    • Manage your stream
      • Stream loading states
      • Session states
      • Stream quality settings
      • Dynamic styling
  • Admin
    • Sharing and permissions
    • Subscriptions
    • Purchase stream hours
  • FAQ
    • Our GPUs (Coreweave)
    • Concurrent user limits
    • Vulkan renderer
    • In-world video support on Linux
  • Guides
    • Add the Odyssey plugin
    • Validate your project settings
    • Troubleshoot "Project zip is invalid"
Powered by GitBook
On this page
  • Sending messages from Unreal
  • Receiving messages on webpage
  1. Embed in a website
  2. Pass messages to and from Unreal

Receiving messages from Unreal

Sending messages from Unreal

Documentation coming soon...

Receiving messages on webpage

Pixel stream messages from Unreal Engine will be transmitted utilizing the MessageChannel API. Parse the message string to facilitate data extraction. Each message will contain two properties: type, which is consistently set to ps, and message, encapsulating the data that has been received from Unreal Engine.

function onMessage(event: Event) {
     const data = JSON.parse(event.data)
    // handle pixel streaming message
     if (data.type === 'ps') {
         const psMessage = data.message
     }
}

Last updated 1 year ago