Show / Hide Table of Contents

    Unity MediaPlayer component

    The MediaPlayer Unity component is a utility component mixing an audio source and a video source for local rendering.

    Important

    FIXME: This component is not currently fully functional. The remote audio data is currently sent directly to the local audio out device by the internal WebRTC implementation without any configuration possible. And the local audio is never rendered. So the MediaPlayer.AudioSource property is unused. The video however capability works as intended. See issue #92 for details.

    The MediaPlayer Unity component

    Property Description
    Source
    AudioSource Reference to the AudioSource instance that the media player outputs the audio of.
    VideoSource Reference to the VideoSource instance that the media player renders the video of.
    MaxVideoFramerate Maximum number of frames per second rendered. Extra frames coming from the video source are discarded.
    Statistics
    EnableStatistics Enable the collecting of video statistics by the media player. This adds some minor overhead.
    FrameLoadStatHolder Reference to a TextMesh instance whose text is set to the number of incoming video frames per second pulled from the video source into the media player's internal queue.
    FramePresentStatHolder Reference to a TextMesh instance whose text is set to the number of video frames per second dequeued from the media player's internal queue and rendered to the texture(s) of the Renderer component associated with this media player.
    FrameSkipStatHolder Reference to a TextMesh instance whose text is set to the number of video frames per second dropped due to the media player's internal queue being full. This corresponds to frames being enqueued faster than they are dequeued, which happens when the source is overflowing the sink, and the sink cannot render all frames.
    • Improve this Doc
    Back to top Generated by DocFX