MixedReality-WebRTC documentation (latest)

This is the MixedReality-WebRTC documentation for the master branch, which contains the latest features and API changes. In general this latest API is incompatible with the NuGet packages.

For the documentation corresponding to other branches, including the release/1.0 branch from which the NuGet 1.x packages are built, use the drop-down selection at the top right of this page.

Caution

MR-WebRTC has been deprecated. We're no longer committing development resources to it, taking pull requests for it, or planning a replacement for it.

• If you want to continue updating it, you must fork and maintain your own branch.

User Manual

• C# library
  • Feature Overview
  • Tutorial (Desktop)
  • Tutorial (UWP)
  • Peer Connection
  • Signaling
• Unity integration
  • Feature Overview
  • Tutorial
  • Peer Connection
  • Signaler
  • Audio
    • MicrophoneSource
    • AudioReceiver
  • Video
    • WebcamSource
    • VideoReceiver
    • VideoRenderer
• Advanced topics
  • Building the Core dependencies from sources

API reference

1. C# Library
   1. PeerConnection
      • The PeerConnection object is the API entry point to establish a remote connection.
   2. Transceiver
      • The transceiver is the "pipe" which transports some audio or video between the two peers.
   3. DataChannel
      • Encapsulates a single data channel for transmitting raw blobs of bytes.
2. Unity Library
   1. PeerConnection
      • The PeerConnection component builds on the same-named library class to expose a remote peer connection.
   2. WebcamSource
      • The WebcamSource component provides access to the local webcam for local rendering and remote streaming.
   3. MicrophoneSource
      • The MicrophoneSource component provides access to the local microphone for audio streaming to the remote peer.