Class VideoRenderer

Utility component used to play video frames obtained from a WebRTC video track. This can indiscriminately play video frames from a video track source on the local peer as well as video frames from a remote video receiver obtaining its frame from a remote WebRTC peer.

Inheritance

Object

VideoRenderer

Namespace: Microsoft.MixedReality.WebRTC.Unity

Assembly: cs.temp.dll.dll

Syntax

public class VideoRenderer : MonoBehaviour

Remarks

This component writes to the attached Material, via the attached Renderer.

Fields

EnableStatistics

Declaration

public bool EnableStatistics

Field Value

Type	Description
Boolean

FrameLoadStatHolder

A textmesh onto which frame load stat data will be written

Declaration

public TextMesh FrameLoadStatHolder

Field Value

Type	Description
TextMesh

Remarks

This is how fast the frames are given from the underlying implementation

FramePresentStatHolder

A textmesh onto which frame present stat data will be written

Declaration

public TextMesh FramePresentStatHolder

Field Value

Type	Description
TextMesh

Remarks

This is how fast we render frames to the display

FrameSkipStatHolder

A textmesh into which frame skip stat dta will be written

Declaration

public TextMesh FrameSkipStatHolder

Field Value

Type	Description
TextMesh

Remarks

This is how often we skip presenting an underlying frame

MaxFramerate

Declaration

public float MaxFramerate

Field Value

Type	Description
Single

Methods

Argb32VideoFrameReady(Argb32VideoFrame)

Declaration

protected void Argb32VideoFrameReady(Argb32VideoFrame frame)

Parameters

Type	Name	Description
Argb32VideoFrame	frame

I420AVideoFrameReady(I420AVideoFrame)

Declaration

protected void I420AVideoFrameReady(I420AVideoFrame frame)

Parameters

Type	Name	Description
I420AVideoFrame	frame

OnDisable()

Declaration

protected void OnDisable()

StartRendering(IVideoSource)

Start rendering the passed source.

Declaration

public void StartRendering(IVideoSource source)

Parameters

Type	Name	Description
IVideoSource	source

Remarks

Can be used to handle VideoStreamStarted or VideoStreamStarted.

StopRendering(IVideoSource)

Stop rendering the passed source. Must be called with the same source passed to StartRendering(IVideoSource)

Declaration

public void StopRendering(IVideoSource _)

Parameters

Type	Name	Description
IVideoSource	_

Remarks

Can be used to handle VideoStreamStopped or VideoStreamStopped.