Show / Hide Table of Contents

    Namespace Microsoft.MixedReality.WebRTC.Unity

    Classes

    AudioSource

    Base class for audio sources plugging into the internal peer connection API to expose a single audio stream to a renderer (MediaPlayer or custom).

    AudioStreamStartedEvent

    Unity event corresponding to a new audio stream being started.

    AudioStreamStoppedEvent

    Unity event corresponding to an on-going audio stream being stopped.

    LocalAudioSource

    This component represents a local audio source added as an audio track to an existing WebRTC peer connection and sent to the remote peer. The audio track can optionally be rendered locally with a MediaPlayer.

    LocalVideoSource

    This component represents a local video source added as a video track to an existing WebRTC peer connection and sent to the remote peer. The video track can optionally be displayed locally with a MediaPlayer.

    MediaPlayer

    Play video frames received from a WebRTC video track.

    NodeDssSignaler

    Simple signaler for debug and testing. This is based on https://github.com/bengreenier/node-dss and SHOULD NOT BE USED FOR PRODUCTION.

    PeerConnection

    High-level wrapper for Unity WebRTC functionalities. This is the API entry point for establishing a connection with a remote peer.

    RemoteAudioSource

    This component represents a remote audio source added as an audio track to an existing WebRTC peer connection by a remote peer and received locally. The audio track can optionally be displayed locally with a MediaPlayer.

    RemoteVideoSource

    This component represents a remote video source added as a video track to an existing WebRTC peer connection by a remote peer and received locally. The video track can optionally be displayed locally with a MediaPlayer.

    Signaler

    Base class for WebRTC signaling implementations in Unity.

    Signaler.Message

    VideoSource

    Base class for video sources plugging into the internal peer connection API to expose a single video stream to a renderer (MediaPlayer or custom).

    VideoStreamStartedEvent

    Unity event corresponding to a new video stream being started.

    VideoStreamStoppedEvent

    Unity event corresponding to an on-going video stream being stopped.

    WebRTCErrorEvent

    A UnityEvent that represents a WebRTC error event.

    Structs

    ConfigurableIceServer

    Represents an Ice server in a simple way that allows configuration from the unity inspector

    VideoCaptureConstraints

    Additional optional constraints applied to the resolution and framerate when selecting a video capture format.

    Enums

    IceType

    Enumeration of the different types of ICE servers.

    LocalVideoSourceFormatMode

    Video capture format selection mode for a local video source.

    Signaler.Message.WireMessageType

    Possible message types as-serialized on the wire

    Back to top Generated by DocFX